From 69a5085e824b68d199bf3e0976b6d1452fc7208a Mon Sep 17 00:00:00 2001 From: arsunda <31108915+arsunda@users.noreply.github.com> Date: Tue, 28 Jul 2020 15:55:58 -0700 Subject: [PATCH 01/29] [Datafactory] Add Support for Cancel Trigger Run Api (#10256) * webhook changes * remove timeout as required * combine and update web auth definitions * revert auth type enum change * Revert "revert auth type enum change" This reverts commit a4c799f437e023dc38ea0b4b6879a9a5799460a1. * Reset to master * whitespace * Add Trigger Cancel API * lint --- .../stable/2018-06-01/datafactory.json | 45 +++++++++++++++++++ .../2018-06-01/entityTypes/Pipeline.json | 2 +- .../examples/TriggerRuns_Cancel.json | 21 +++++++++ .../preview/2019-06-01-preview/artifacts.json | 36 +++++++++++++++ .../examples/TriggerRuns_Cancel.json | 19 ++++++++ 5 files changed, 122 insertions(+), 1 deletion(-) create mode 100644 specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/TriggerRuns_Cancel.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/TriggerRuns_Cancel.json 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 e46d6181e288..8ac8e38601ed 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 @@ -3098,6 +3098,51 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/triggers/{triggerName}/triggerRuns/{runId}/cancel": { + "post": { + "tags": [ + "triggerruns" + ], + "operationId": "TriggerRuns_Cancel", + "x-ms-examples": { + "Triggers_Rerun": { + "$ref": "./examples/TriggerRuns_Cancel.json" + } + }, + "description": "Cancel a single trigger instance by runId.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/runId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "TriggerRun has been cancelled." + }, + "default": { + "description": "An error response received from the Azure Data Factory service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/queryTriggerRuns": { "post": { "tags": [ 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 4ccc318307d5..e7963bb5c123 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 @@ -6586,7 +6586,7 @@ }, "reportStatusOnCallBack": { "type": "object", - "description": "When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean)." + "description": "When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean)." } }, "required": [ diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/TriggerRuns_Cancel.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/TriggerRuns_Cancel.json new file mode 100644 index 000000000000..b06046f294f8 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/TriggerRuns_Cancel.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "triggerName": "exampleTrigger", + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:24 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1198", + "x-ms-request-id": "5aa854a5-7ac0-4c7e-9356-79c657f4e231", + "x-ms-correlation-request-id": "5aa854a5-7ac0-4c7e-9356-79c657f4e231" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json index 0dfc0e51ebbd..c7b8fb876b6d 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json @@ -1157,6 +1157,42 @@ } } }, + "/triggers/{triggerName}/triggerRuns/{runId}/cancel": { + "post": { + "tags": [ + "triggerruns" + ], + "operationId": "TriggerRun_CancelTriggerInstance", + "x-ms-examples": { + "Triggers_Rerun": { + "$ref": "./examples/TriggerRuns_Cancel.json" + } + }, + "description": "Cancel single trigger instance by runId.", + "parameters": [ + { + "$ref": "#/parameters/triggerName" + }, + { + "$ref": "#/parameters/runId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "TriggerRun has been cancelled." + }, + "default": { + "description": "An error response received from the Azure Synapse service.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, "/queryTriggerRuns": { "post": { "tags": [ diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/TriggerRuns_Cancel.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/TriggerRuns_Cancel.json new file mode 100644 index 000000000000..169d70a4e4b5 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/TriggerRuns_Cancel.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": { + "headers": { + "Date": "Sat, 16 Jun 2018 00:46:24 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1198", + "x-ms-request-id": "5aa854a5-7ac0-4c7e-9356-79c657f4e231", + "x-ms-correlation-request-id": "5aa854a5-7ac0-4c7e-9356-79c657f4e231" + } + } + } +} From c18564bd0588d5544556ae8f0ab53e5c2df5ccf4 Mon Sep 17 00:00:00 2001 From: Vivian Liu Date: Tue, 28 Jul 2020 15:59:20 -0700 Subject: [PATCH 02/29] small updates (#10254) --- .../examples/application_get.json | 2 -- .../examples/application_list.json | 5 +--- .../examples/devicecredentials_get.json | 6 ++-- ...devices_attestations_set_symmetricKey.json | 8 ++--- .../devices_attestations_set_tpm.json | 4 +-- .../examples/devices_properties_get.json | 30 ++++++++++++++----- .../examples/devices_properties_update.json | 30 ++++++++----------- .../examples/devicetemplates_create.json | 10 +++---- .../2019-10-28-preview/iotcentral.json | 15 +++++----- 9 files changed, 57 insertions(+), 53 deletions(-) diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/application_get.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/application_get.json index 92cead192a9b..380ce4ca0668 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/application_get.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/application_get.json @@ -2,8 +2,6 @@ "title": "Get an application by Id", "description": "Get an application by Id.", "parameters": { - "centralDnsSuffixInPath": "azureiotcentral.com", - "subdomain": "appsubdomain", "application_id": "194e282c-290a-4858-b68f-4274690697fc" }, "responses": { diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/application_list.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/application_list.json index f32e2b04e93d..e90e0ecd4bac 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/application_list.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/application_list.json @@ -1,10 +1,7 @@ { "title": "List applications", "description": "List applications that are accessible to the signed-in user.", - "parameters": { - "centralDnsSuffixInPath": "azureiotcentral.com", - "subdomain": "appsubdomain" - }, + "parameters": {}, "responses": { "200": { "body": { diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicecredentials_get.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicecredentials_get.json index fca7fc82f2c1..54b2c4c8aabf 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicecredentials_get.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicecredentials_get.json @@ -9,10 +9,10 @@ "responses": { "200": { "body": { - "idScope": "", + "idScope": "", "symmetricKey": { - "primaryKey": "XaMfV3vryCQw963L2IALf1SdApQRzSIBQd13/fassqM=", - "secondaryKey": "s+4uT31TRZJcTSGxZUPZb1yznjTicu4jr9tXNrg+xIQ=" + "primaryKey": "", + "secondaryKey": "" } } } diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set_symmetricKey.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set_symmetricKey.json index 42fdabd7c518..6bdfbb5b6efc 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set_symmetricKey.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set_symmetricKey.json @@ -8,8 +8,8 @@ "body": { "type": "SymmetricKeyAttestation", "symmetricKey": { - "primaryKey": "XaMfV3vryCQw963L2IALf1SdApQRzSIBQd13/fassqM=", - "secondaryKey": "s+4uT31TRZJcTSGxZUPZb1yznjTicu4jr9tXNrg+xIQ=" + "primaryKey": "", + "secondaryKey": "" } } }, @@ -18,8 +18,8 @@ "body": { "type": "SymmetricKeyAttestation", "symmetricKey": { - "primaryKey": "XaMfV3vryCQw963L2IALf1SdApQRzSIBQd13/fassqM=", - "secondaryKey": "s+4uT31TRZJcTSGxZUPZb1yznjTicu4jr9tXNrg+xIQ=" + "primaryKey": "", + "secondaryKey": "" } } } diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set_tpm.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set_tpm.json index 35fb1496150d..94c03cc26f7c 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set_tpm.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_attestations_set_tpm.json @@ -8,7 +8,7 @@ "body": { "type": "TpmAttestation", "tpm": { - "endorsementKey": "AToAAQALAAMAsgAgg3GXZ0SEs/gakMyNRqXXJP1S124GUgtk8qHaGzMUaaoABgCAAEMAEAgAAAAAAAEAxsj2gUScTk1UjuioeTlfGYZrrimExB+bScH75adUMRIi2UOMxG1kw4y+9RW/IVoMl4e620VxZad0ARX2gUqVjYO7KPVt3dyKhZS3dkcvfBisBhP1XH9B33VqHG9SHnbnQXdBUaCgKAfxome8UmBKfe+naTsE5fkvjb/do3/dD6l4sGBwFCnKRdln4XpM03zLpoHFao8zOwt8l/uP3qUIxmCYv9A7m69Ms+5/pCkTu/rK4mRDsfhZ0QLfbzVI6zQFOKF/rwsfBtFeWlWtcuJMKlXdD8TXWElTzgh7JS4qhFzreL0c1mI0GCj+Aws0usZh7dLIVPnlgZcBhgy1SSDQMQ==" + "endorsementKey": "" } } }, @@ -17,7 +17,7 @@ "body": { "type": "TpmAttestation", "tpm": { - "endorsementKey": "AToAAQALAAMAsgAgg3GXZ0SEs/gakMyNRqXXJP1S124GUgtk8qHaGzMUaaoABgCAAEMAEAgAAAAAAAEAxsj2gUScTk1UjuioeTlfGYZrrimExB+bScH75adUMRIi2UOMxG1kw4y+9RW/IVoMl4e620VxZad0ARX2gUqVjYO7KPVt3dyKhZS3dkcvfBisBhP1XH9B33VqHG9SHnbnQXdBUaCgKAfxome8UmBKfe+naTsE5fkvjb/do3/dD6l4sGBwFCnKRdln4XpM03zLpoHFao8zOwt8l/uP3qUIxmCYv9A7m69Ms+5/pCkTu/rK4mRDsfhZ0QLfbzVI6zQFOKF/rwsfBtFeWlWtcuJMKlXdD8TXWElTzgh7JS4qhFzreL0c1mI0GCj+Aws0usZh7dLIVPnlgZcBhgy1SSDQMQ==" + "endorsementKey": "" } } } diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_properties_get.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_properties_get.json index 45baf0130156..74ec4cc31c13 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_properties_get.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_properties_get.json @@ -1,6 +1,6 @@ { "title": "Get device properties", - "description": "Get the current values of all device properties.", + "description": "Get the current values of all device properties. Properties that have never been set by the device or by a user or API request will not be returned.", "parameters": { "centralDnsSuffixInPath": "azureiotcentral.com", "subdomain": "appsubdomain", @@ -11,13 +11,29 @@ "body": { "deviceinfo": { "manufacturer": "manufacturer", + "$metadata": { + "manufacturer": { + "lastUpdateTime": "2020-07-21T19:06:50.9718608Z" + }, + "model": { + "lastUpdateTime": "2020-07-21T19:06:50.9718608Z" + }, + "swVersion": { + "lastUpdateTime": "2020-07-21T19:06:50.9718608Z" + } + }, "model": "model", - "swVersion": "swVersion", - "osName": "osName", - "processorArchitecture": "processorArchitecture", - "processorManufacturer": "processorManufacturer", - "totalStorage": 41, - "totalMemory": 49 + "swVersion": "swVersion" + }, + "settings": { + "fanSpeed": 12.5, + "$metadata": { + "fanSpeed": { + "desiredValue": 30, + "desiredVersion": 2, + "lastUpdateTime": "2020-07-21T19:06:50.9718608Z" + } + } } } } diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_properties_update.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_properties_update.json index d8c1316a830f..f88d9a5dd4a3 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_properties_update.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_properties_update.json @@ -6,30 +6,24 @@ "subdomain": "appsubdomain", "device_id": "mx1", "body": { - "device_info": { - "manufacturer": "manufacturer", - "model": "model", - "swVersion": "swVersion", - "osName": "osName", - "processorArchitecture": "processorArchitecture", - "processorManufacturer": "processorManufacturer", - "totalStorage": 24, - "totalMemory": 18 + "settings": { + "voltage": 25, + "current": 7 } } }, "responses": { "202": { "body": { - "deviceinfo": { - "manufacturer": "TODO", - "model": "model", - "swVersion": "swVersion", - "osName": "osName", - "processorArchitecture": "processorArchitecture", - "processorManufacturer": "processorManufacturer", - "totalStorage": 41, - "totalMemory": 49 + "settings": { + "$metadata": { + "voltage": { + "desiredValue": 25 + }, + "current": { + "desiredValue": 7 + } + } } } } diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicetemplates_create.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicetemplates_create.json index 5013639058c3..d9210837f4a1 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicetemplates_create.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devicetemplates_create.json @@ -1,6 +1,6 @@ { "title": "Create a device template", - "description": "Creates and publishes a device template. In the body, specify the full device template object.", + "description": "Creates and publishes a device template. In the body, specify the full device template object. Default views will be automatically generated.", "parameters": { "centralDnsSuffixInPath": "azureiotcentral.com", "subdomain": "appsubdomain", @@ -39,7 +39,7 @@ "displayName": "Temperature", "name": "Temperature", "schema": "double", - "unit": "Units/Temperature/celsius" + "unit": "celsius" }, { "@id": "urn:storeAnalyticsCheckoutPnp:Interface:Humidity:1", @@ -50,7 +50,7 @@ "displayName": "Humidity", "name": "Humidity", "schema": "double", - "unit": "Units/Humidity/percent" + "unit": "percent" }, { "@id": "urn:storeAnalyticsCheckoutPnp:Interface:Occupancy:1", @@ -110,7 +110,7 @@ "displayName": "Temperature", "name": "Temperature", "schema": "double", - "unit": "Units/Temperature/celsius" + "unit": "celsius" }, { "@id": "urn:storeAnalyticsCheckoutPnp:Interface:Humidity:1", @@ -121,7 +121,7 @@ "displayName": "Humidity", "name": "Humidity", "schema": "double", - "unit": "Units/Humidity/percent" + "unit": "percent" }, { "@id": "urn:storeAnalyticsCheckoutPnp:Interface:Occupancy:1", diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json index 0d512680cfed..cf4e8bbfa90e 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json @@ -304,10 +304,6 @@ "description": "Display name of the device.", "type": "string" }, - "description": { - "description": "Detailed description of the device.", - "type": "string" - }, "instanceOf": { "description": "The device template definition for the device.", "type": "string" @@ -504,7 +500,8 @@ "properties": { "email": { "description": "Email address of the user.", - "type": "string" + "type": "string", + "format": "email" } }, "required": [ @@ -1186,7 +1183,7 @@ "/apiTokens": { "get": { "operationId": "ApiTokens_List", - "summary": "Get the list of API tokens in an application.", + "summary": "Get the list of API tokens in an application. The token value will never be returned for security reasons.", "x-ms-examples": { "List API tokens": { "$ref": "./examples/apitoken_list.json" @@ -1234,7 +1231,7 @@ }, "put": { "operationId": "ApiTokens_Set", - "summary": "Create a new API token in the application.", + "summary": "Create a new API token in the application to use in the IoT Central public API. The token value will be returned in the response, and won't be returned again in subsequent requests.", "x-ms-examples": { "Create API token": { "$ref": "./examples/apitoken_create.json" @@ -1446,7 +1443,7 @@ }, "put": { "operationId": "DeviceTemplates_Set", - "summary": "Create or update a device template", + "summary": "Publish a new device template or update the cloud properties and overrides of an existing device template. Default views will be automatically generated for new device templates created this way.", "x-ms-examples": { "Create a device template": { "$ref": "./examples/devicetemplates_create.json" @@ -1943,6 +1940,7 @@ "get": { "operationId": "Devices_GetComponentTelemetryValue", "summary": "Get device telemetry value", + "description": "Get the last telemetry value from a device.", "x-ms-examples": { "Get telemetry": { "$ref": "./examples/devices_telemetry_get.json" @@ -2192,6 +2190,7 @@ "get": { "operationId": "Devices_GetModuleComponentTelemetryValue", "summary": "Get module telemetry value", + "description": "Get the last telemetry value from a module.", "x-ms-examples": { "Get telemetry from module": { "$ref": "./examples/modules_telemetry_get.json" From aa9c38428747862053528d2b47f17189c3364625 Mon Sep 17 00:00:00 2001 From: Shimon Arzuan <58290359+shimonar1171@users.noreply.github.com> Date: Wed, 29 Jul 2020 09:51:35 +0300 Subject: [PATCH 03/29] Add On Premise Sql Resource Details (#10041) * Add On Premise Sql Resource Details * Create new API version * Remove OnPremiseSql for old version * Add changes to readme file * Add API Example * Add new ResourceDetails type for subassessment * Add examples Changed the version type to stable * Changed readme file * fixed object defintion probleam. add new version to ruby. * Removed the new version * removed files --- .../resource-manager/common/v1/types.json | 31 ++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/specification/security/resource-manager/common/v1/types.json b/specification/security/resource-manager/common/v1/types.json index 48bec7b159a3..fca7f0ceb5c6 100644 --- a/specification/security/resource-manager/common/v1/types.json +++ b/specification/security/resource-manager/common/v1/types.json @@ -169,7 +169,8 @@ "description": "The platform where the assessed resource resides", "enum": [ "Azure", - "OnPremise" + "OnPremise", + "OnPremiseSql" ], "x-ms-enum": { "name": "source", @@ -182,6 +183,10 @@ { "value": "OnPremise", "description": "Resource in an on premise machine connected to Azure cloud" + }, + { + "value": "OnPremiseSql", + "description": "SQL Resource in an on premise machine connected to Azure cloud" } ] } @@ -242,6 +247,30 @@ "machineName" ] }, + "OnPremiseSqlResourceDetails": { + "type": "object", + "description": "Details of the On Premise Sql resource that was assessed", + "x-ms-discriminator-value": "OnPremiseSql", + "allOf": [ + { + "$ref": "#/definitions/OnPremiseResourceDetails" + } + ], + "properties": { + "serverName": { + "type": "string", + "description": "The Sql server name installed on the machine" + }, + "databaseName": { + "type": "string", + "description": "The Sql database name installed on the machine" + } + }, + "required": [ + "serverName", + "databaseName" + ] + }, "AzureResourceLinks": { "description": "array of azure resource IDs", "readOnly": true, From baaa15fe04901368a3de15a00dbf953211338105 Mon Sep 17 00:00:00 2001 From: Elad Perets <7473455+eladperets@users.noreply.github.com> Date: Wed, 29 Jul 2020 18:58:27 -0700 Subject: [PATCH 04/29] Update Microsoft.Resources swagger to include new alias contract (#10243) * Update Microsoft.Resources swagger to include new alias contract (this is already exposed for some time now, but this part of the spec seems out-of-date). Also added the default API version and the API profile properties * Fix prettier errors * Address PR comments --- .../examples/GetNamedProviderAtTenant.json | 253 ++++++++++++++++++ .../stable/2020-06-01/resources.json | 122 +++++++++ 2 files changed, 375 insertions(+) create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/GetNamedProviderAtTenant.json diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/GetNamedProviderAtTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/GetNamedProviderAtTenant.json new file mode 100644 index 000000000000..0c2168e47790 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/GetNamedProviderAtTenant.json @@ -0,0 +1,253 @@ +{ + "parameters": { + "$expand": "resourceTypes/aliases", + "resourceProviderNamespace": "Microsoft.Storage", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "namespace": "Microsoft.Storage", + "resourceTypes": [ + { + "resourceType": "storageAccounts", + "locations": [ + "East US", + "East US 2", + "East US 2 (Stage)", + "West US", + "West Europe", + "East Asia", + "Southeast Asia", + "Japan East", + "Japan West", + "North Central US", + "South Central US", + "Central US", + "North Europe", + "Brazil South", + "Australia East", + "Australia Southeast", + "South India", + "Central India", + "West India", + "Canada East", + "Canada Central", + "West US 2", + "West Central US", + "UK South", + "UK West", + "Korea Central", + "Korea South", + "East US 2 EUAP", + "Central US EUAP", + "France Central", + "France South", + "Australia Central", + "Australia Central 2", + "South Africa West", + "South Africa North", + "UAE Central", + "UAE North", + "Switzerland North", + "Switzerland West", + "Germany West Central", + "Germany North", + "Norway East", + "Norway West", + "South Central US STG", + "Brazil Southeast" + ], + "apiVersions": [ + "2019-06-01", + "2019-04-01", + "2018-11-01", + "2018-07-01", + "2018-03-01-preview", + "2018-02-01", + "2017-10-01", + "2017-06-01", + "2016-12-01", + "2016-05-01", + "2016-01-01", + "2015-06-15", + "2015-05-01-preview" + ], + "defaultApiVersion": "2019-06-01", + "apiProfiles": [ + { + "profileVersion": "2019-03-01-hybrid", + "apiVersion": "2017-10-01" + }, + { + "profileVersion": "2017-03-09-profile", + "apiVersion": "2016-01-01" + }, + { + "profileVersion": "2018-03-01-hybrid", + "apiVersion": "2016-01-01" + }, + { + "profileVersion": "2018-06-01-profile", + "apiVersion": "2017-10-01" + } + ], + "aliases": [ + { + "name": "Microsoft.Storage/storageAccounts/accountType", + "paths": [ + { + "path": "properties.accountType", + "apiVersions": [ + "2015-06-15", + "2015-05-01-preview" + ] + }, + { + "path": "sku.name", + "apiVersions": [ + "2018-11-01", + "2018-11-09", + "2018-07-01", + "2018-03-01-Preview", + "2018-02-01", + "2017-10-01", + "2017-06-01", + "2016-12-01", + "2016-05-01", + "2016-01-01" + ] + } + ], + "defaultPath": "sku.name" + }, + { + "name": "Microsoft.Storage/storageAccounts/sku.name", + "paths": [ + { + "path": "properties.accountType", + "apiVersions": [ + "2015-06-15", + "2015-05-01-preview" + ] + }, + { + "path": "sku.name", + "apiVersions": [ + "2018-11-01", + "2018-11-09", + "2018-07-01", + "2018-03-01-Preview", + "2018-02-01", + "2017-10-01", + "2017-06-01", + "2016-12-01", + "2016-05-01", + "2016-01-01" + ] + } + ], + "defaultPath": "sku.name" + }, + { + "name": "Microsoft.Storage/storageAccounts/accessTier", + "paths": [ + { + "path": "properties.accessTier", + "apiVersions": [ + "2018-11-01", + "2018-11-09", + "2018-07-01", + "2018-03-01-Preview", + "2018-02-01", + "2017-10-01", + "2017-06-01", + "2016-12-01", + "2016-05-01", + "2016-01-01", + "2015-06-15", + "2015-05-01-preview" + ] + } + ], + "defaultPath": "properties.accessTier" + }, + { + "name": "Microsoft.Storage/storageAccounts/enableBlobEncryption", + "paths": [ + { + "path": "properties.encryption.services.blob.enabled", + "apiVersions": [ + "2018-11-01", + "2018-11-09", + "2018-07-01", + "2018-03-01-Preview", + "2018-02-01", + "2017-10-01", + "2017-06-01", + "2016-12-01", + "2016-05-01", + "2016-01-01", + "2015-06-15", + "2015-05-01-preview" + ] + } + ], + "defaultPath": "properties.encryption.services.blob.enabled" + }, + { + "name": "Microsoft.Storage/storageAccounts/enableFileEncryption", + "paths": [ + { + "path": "properties.encryption.services.file.enabled", + "apiVersions": [ + "2018-11-01", + "2018-11-09", + "2018-07-01", + "2018-03-01-Preview", + "2018-02-01", + "2017-10-01", + "2017-06-01", + "2016-12-01", + "2016-05-01", + "2016-01-01", + "2015-06-15", + "2015-05-01-preview" + ] + } + ], + "defaultPath": "properties.encryption.services.file.enabled" + }, + { + "name": "Microsoft.Storage/storageAccounts/supportsHttpsTrafficOnly", + "paths": [ + { + "path": "properties.supportsHttpsTrafficOnly", + "apiVersions": [ + "2018-11-09", + "2018-03-01-Preview", + "2016-05-01", + "2016-01-01", + "2015-06-15", + "2015-05-01-preview" + ], + "metadata": { + "type": "NotSpecified", + "attributes": "None" + } + } + ], + "defaultPath": "properties.supportsHttpsTrafficOnly", + "defaultMetadata": { + "type": "Boolean", + "attributes": "Modifiable" + } + } + ], + "capabilities": "SupportsTags, SupportsLocation" + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json index 46af7f8d08fc..96b7e2efcdaa 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json @@ -2230,6 +2230,11 @@ "tags": [ "Providers" ], + "x-ms-examples": { + "Get a resource provider at tenant scope": { + "$ref": "./examples/GetNamedProviderAtTenant.json" + } + }, "operationId": "Providers_GetAtTenantScope", "description": "Gets the specified resource provider at the tenant level.", "parameters": [ @@ -4581,6 +4586,100 @@ }, "description": "An error response for a resource management request." }, + "ApiProfile": { + "properties": { + "profileVersion": { + "type": "string", + "readOnly": true, + "description": "The profile version." + }, + "apiVersion": { + "type": "string", + "readOnly": true, + "description": "The API version." + } + } + }, + "AliasPathMetadata": { + "properties": { + "type": { + "type": "string", + "readOnly": true, + "enum": [ + "NotSpecified", + "Any", + "String", + "Object", + "Array", + "Integer", + "Number", + "Boolean" + ], + "x-ms-enum": { + "name": "AliasPathTokenType", + "modelAsString": true, + "values": [ + { + "value": "NotSpecified", + "description": "The token type is not specified." + }, + { + "value": "Any", + "description": "The token type can be anything." + }, + { + "value": "String", + "description": "The token type is string." + }, + { + "value": "Object", + "description": "The token type is object." + }, + { + "value": "Array", + "description": "The token type is array." + }, + { + "value": "Integer", + "description": "The token type is integer." + }, + { + "value": "Number", + "description": "The token type is number." + }, + { + "value": "Boolean", + "description": "The token type is boolean." + } + ] + }, + "description": "The type of the token that the alias path is referring to." + }, + "attributes": { + "type": "string", + "readOnly": true, + "enum": [ + "None", + "Modifiable" + ], + "x-ms-enum": { + "name": "AliasPathAttributes", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "The token that the alias path is referring to has no attributes." + }, + { + "value": "Modifiable", + "description": "The token that the alias path is referring to is modifiable by policies with 'modify' effect." + } + ] + }, + "description": "The attributes of the token that the alias path is referring to." + } + } + }, "AliasPath": { "properties": { "path": { @@ -4597,6 +4696,11 @@ "pattern": { "$ref": "#/definitions/AliasPattern", "description": "The pattern for an alias path." + }, + "metadata": { + "readOnly": true, + "$ref": "#/definitions/AliasPathMetadata", + "description": "The metadata of the alias path. If missing, fall back to the default metadata of the alias." } }, "description": "The type of the paths for alias." @@ -4683,6 +4787,11 @@ "defaultPattern": { "$ref": "#/definitions/AliasPattern", "description": "The default pattern for an alias." + }, + "defaultMetadata": { + "readOnly": true, + "$ref": "#/definitions/AliasPathMetadata", + "description": "The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata" } }, "description": "The alias type. " @@ -4714,6 +4823,19 @@ }, "description": "The API version." }, + "defaultApiVersion": { + "type": "string", + "readOnly": true, + "description": "The default API version." + }, + "apiProfiles": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ApiProfile" + }, + "description": "The API profiles for the resource provider." + }, "capabilities": { "type": "string", "description": "The additional capabilities offered by this resource type." From 15a2aa21925ea2a584f816972563f95d3021f1fa Mon Sep 17 00:00:00 2001 From: N'Godjigui Junior Diarrassouba <41027427+madewithsmiles@users.noreply.github.com> Date: Wed, 29 Jul 2020 20:58:57 -0500 Subject: [PATCH 05/29] Adding new path-based rule for the Compute API (#10253) This is a new yml rule that specifies a configuration helpful to the cplat (Compute Platform) sdk team. This configuration rule mainly specifies a path, here the Compute Management library's path, and an email that will be sent by the bot whenever a PR is opened and the PR changes are in the Compute Management library's path. --- .github/sla.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/.github/sla.yml b/.github/sla.yml index f0ce3592d482..005dfda9139a 100644 --- a/.github/sla.yml +++ b/.github/sla.yml @@ -84,3 +84,18 @@ subject: "Action Required: Please respond to issue ${URL}" to: ${ASSIGNEE} cc: vscswagger@microsoft.com + +- scheduleTask: + action: sendEmail + scope: pull_request + name: "send email given path change" + trigger: + - path + args: + message: '

You have just completed the first step towards onboarding your API change to the Compute Management library.

We (the CPlatSDK/PowerShell team) manage the Compute library's API and SDK for the following clients: Swagger (REST api), .NET SDK, and Azure PowerShell.

You've just opened a PR making changes in the Compute Management Library's path of the Azure REST Api Specs repository.

What's next?

  1. Your api specs need to be reviewed and approved by us and the ARM team
  2. Make sure you that can generate the .NET SDK from your API specs using the Autorest tool (NET SDK autogeneration)
  3. While your specs are getting reviewed, you should be working on the .NET SDK. (SDK repo)
    1. Once you generate the .NET SDK, you need to create the SDK tests and perform recordings and playbacks. (NET SDK testing)
    2. With the newly generated SDK with tests, you can make a pull request to the SDK repository.
      Make sure to add a reference to your Swagger pull request in the comments.
  4. [If applicable] At this stage, you can get started on the Azure PowerShell part.
    1. All you need to do is send a design doc of any change/new Azure PowerShell cmdlet related to your api by creating an issue with your design here.
      Then, send an email to azdevxpsdr@microsoft.com with the issue number and cc our dl (cplatsdkdev@microsoft.com) on the email, so we can leave comments on your design doc as well.
    2. Once your PowerShell cmdlet design has been approved, send an email to our team
      We will implement and test the PowerShell cmdlet following the approved design. We will then make a pull request to the appropriate repository
  5. [If applicable] You can also get started on any Azure CLI module or extension for your API change. Find more information about next steps on that process here.
  • To view the full CPlat SDK PowerShell API onboarding wiki, please visit aka.ms/cplatsdk

This email was automatically sent. Please send an email to cplatsdkdev@microsoft.com if you have any questions.

' + targetPaths: + - "specification/compute/resource-manager/Microsoft.Compute/**" + subject: "[Action Required] CPlat Swagger Pull Request opened: Next steps" + to: ${AUTHOR} + cc: + - cplatsdkdev@microsoft.com From 9d13acc8b35dd70a559632ee0eba2744c375c114 Mon Sep 17 00:00:00 2001 From: nivats <41890611+nivats@users.noreply.github.com> Date: Thu, 30 Jul 2020 07:30:20 +0530 Subject: [PATCH 06/29] Dev storageimportexport microsoft.import export 2016 11 01 (#10124) * added swagger for new version of API * fixed warning * Fixed failing spell check and other tests * tried fixing avocado * tried fixing avocado for readme * added fix for lintdiff failure --- .../2020-08-01/examples/CreateExportJob.json | 156 ++ .../stable/2020-08-01/examples/CreateJob.json | 162 ++ .../stable/2020-08-01/examples/DeleteJob.json | 11 + .../2020-08-01/examples/GetExportJob.json | 68 + .../stable/2020-08-01/examples/GetJob.json | 69 + .../2020-08-01/examples/GetLocation.json | 31 + .../examples/ListBitLockerKeys.json | 20 + .../examples/ListJobsInResourceGroup.json | 69 + .../examples/ListJobsInSubscription.json | 139 ++ .../2020-08-01/examples/ListLocations.json | 55 + .../2020-08-01/examples/ListOperations.json | 67 + .../2020-08-01/examples/UpdateExportJob.json | 74 + .../stable/2020-08-01/examples/UpdateJob.json | 76 + .../2020-08-01/storageimportexport.json | 1313 +++++++++++++++++ .../resource-manager/readme.go.md | 15 + .../resource-manager/readme.md | 33 + 16 files changed, 2358 insertions(+) create mode 100644 specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/CreateExportJob.json create mode 100644 specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/CreateJob.json create mode 100644 specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/DeleteJob.json create mode 100644 specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/GetExportJob.json create mode 100644 specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/GetJob.json create mode 100644 specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/GetLocation.json create mode 100644 specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListBitLockerKeys.json create mode 100644 specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListJobsInResourceGroup.json create mode 100644 specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListJobsInSubscription.json create mode 100644 specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListLocations.json create mode 100644 specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListOperations.json create mode 100644 specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/UpdateExportJob.json create mode 100644 specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/UpdateJob.json create mode 100644 specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/storageimportexport.json diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/CreateExportJob.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/CreateExportJob.json new file mode 100644 index 000000000000..45993841892d --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/CreateExportJob.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "api-version": "2020-08-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "jobName": "myExportJob", + "body": { + "location": "West US", + "properties": { + "storageAccountId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType": "Export", + "returnAddress": { + "recipientName": "Test", + "streetAddress1": "Street1", + "streetAddress2": "street2", + "city": "Redmond", + "stateOrProvince": "wa", + "postalCode": "98007", + "countryOrRegion": "USA", + "phone": "4250000000", + "email": "Test@contoso.com" + }, + "returnShipping": { + "carrierName": "FedEx", + "carrierAccountNumber": "989ffff" + }, + "diagnosticsPath": "waimportexport", + "logLevel": "Verbose", + "backupDriveManifest": true, + "export": { + "blobList": { + "blobPathPrefix": [ + "/" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageAccountId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType": "Export", + "returnAddress": { + "recipientName": "Test", + "streetAddress1": "Street1", + "streetAddress2": "street2", + "city": "Redmond", + "stateOrProvince": "wa", + "postalCode": "98007", + "countryOrRegion": "USA", + "phone": "4250000000", + "email": "Test@contoso.com" + }, + "returnShipping": { + "carrierName": "FedEx", + "carrierAccountNumber": "989ffff" + }, + "shippingInformation": { + "recipientName": "Microsoft Azure Import/Export Service", + "streetAddress1": "2045 Lafayette Street", + "streetAddress2": "", + "city": "Santa Clara", + "stateOrProvince": "CA", + "postalCode": "95050", + "countryOrRegion": "USA", + "phone": "408 0000 0000", + "additionalInformation": "" + }, + "diagnosticsPath": "waimportexport", + "logLevel": "Verbose", + "backupDriveManifest": true, + "cancelRequested": false, + "state": "Creating", + "export": { + "blobList": { + "blobPathPrefix": [ + "/" + ] + } + }, + "provisioningState": "Succeeded", + "encryptionKey": { + "kekType": "MicrosoftManaged" + } + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ImportExport/jobs/myExportJob", + "name": "myExportJob", + "type": "Microsoft.ImportExport/jobs", + "location": "West US" + } + }, + "201": { + "body": { + "properties": { + "storageAccountId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType": "Export", + "returnAddress": { + "recipientName": "Test", + "streetAddress1": "Street1", + "streetAddress2": "street2", + "city": "Redmond", + "stateOrProvince": "wa", + "postalCode": "98007", + "countryOrRegion": "USA", + "phone": "4250000000", + "email": "Test@contoso.com" + }, + "returnShipping": { + "carrierName": "FedEx", + "carrierAccountNumber": "989ffff" + }, + "shippingInformation": { + "recipientName": "Microsoft Azure Import/Export Service", + "streetAddress1": "2045 Lafayette Street", + "streetAddress2": "", + "city": "Santa Clara", + "stateOrProvince": "CA", + "postalCode": "95050", + "countryOrRegion": "USA", + "phone": "408 0000 0000", + "additionalInformation": "" + }, + "diagnosticsPath": "waimportexport", + "logLevel": "Verbose", + "backupDriveManifest": true, + "cancelRequested": false, + "state": "Creating", + "export": { + "blobList": { + "blobPathPrefix": [ + "/" + ] + } + }, + "provisioningState": "Succeeded", + "encryptionKey": { + "kekType": "MicrosoftManaged" + } + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ImportExport/jobs/myExportJob", + "name": "myExportJob", + "type": "Microsoft.ImportExport/jobs", + "location": "West US" + } + } + } +} diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/CreateJob.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/CreateJob.json new file mode 100644 index 000000000000..51c70223bd5b --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/CreateJob.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "api-version": "2020-08-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "jobName": "myJob", + "body": { + "location": "West US", + "properties": { + "storageAccountId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType": "Import", + "returnAddress": { + "recipientName": "Test", + "streetAddress1": "Street1", + "streetAddress2": "street2", + "city": "Redmond", + "stateOrProvince": "wa", + "postalCode": "98007", + "countryOrRegion": "USA", + "phone": "4250000000", + "email": "Test@contoso.com" + }, + "returnShipping": { + "carrierName": "FedEx", + "carrierAccountNumber": "989ffff" + }, + "diagnosticsPath": "waimportexport", + "logLevel": "Verbose", + "backupDriveManifest": true, + "driveList": [ + { + "driveId": "9CA995BB", + "bitLockerKey": "238810-662376-448998-450120-652806-203390-606320-483076", + "manifestFile": "\\8a0c23f7-14b7-470a-9633-fcd46590a1bc.manifest", + "manifestHash": "4228EC5D8E048CB9B515338C789314BE8D0B2FDBC7C7A0308E1C826242CDE74E", + "driveHeaderHash": "0:1048576:FB6B6ED500D49DA6E0D723C98D42C657F2881CC13357C28DCECA6A524F1292501571A321238540E621AB5BD9C9A32637615919A75593E6CB5C1515DAE341CABF;135266304:143360:C957A189AFC38C4E80731252301EB91427CE55E61448FA3C73C6FDDE70ABBC197947EC8D0249A2C639BB10B95957D5820A4BE8DFBBF76FFFA688AE5CE0D42EC3" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageAccountId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType": "Import", + "returnAddress": { + "recipientName": "Test", + "streetAddress1": "Street1", + "streetAddress2": "street2", + "city": "Redmond", + "stateOrProvince": "wa", + "postalCode": "98007", + "countryOrRegion": "USA", + "phone": "4250000000", + "email": "Test@contoso.com" + }, + "returnShipping": { + "carrierName": "FedEx", + "carrierAccountNumber": "989ffff" + }, + "shippingInformation": { + "recipientName": "Microsoft Azure Import/Export Service", + "streetAddress1": "2045 Lafayette Street", + "streetAddress2": "", + "city": "Santa Clara", + "stateOrProvince": "CA", + "postalCode": "95050", + "countryOrRegion": "USA", + "phone": "408 0000 0000", + "additionalInformation": "" + }, + "diagnosticsPath": "waimportexport", + "logLevel": "Verbose", + "backupDriveManifest": true, + "cancelRequested": false, + "state": "Creating", + "driveList": [ + { + "driveId": "9CA995BB", + "manifestFile": "\\8a0c23f7-14b7-470a-9633-fcd46590a1bc.manifest", + "manifestHash": "4228EC5D8E048CB9B515338C789314BE8D0B2FDBC7C7A0308E1C826242CDE74E", + "driveHeaderHash": "0:1048576:FB6B6ED500D49DA6E0D723C98D42C657F2881CC13357C28DCECA6A524F1292501571A321238540E621AB5BD9C9A32637615919A75593E6CB5C1515DAE341CABF;135266304:143360:C957A189AFC38C4E80731252301EB91427CE55E61448FA3C73C6FDDE70ABBC197947EC8D0249A2C639BB10B95957D5820A4BE8DFBBF76FFFA688AE5CE0D42EC3", + "state": "Specified" + } + ], + "provisioningState": "Succeeded", + "encryptionKey": { + "kekType": "MicrosoftManaged" + } + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ImportExport/jobs/myJob", + "name": "myJob", + "type": "Microsoft.ImportExport/jobs", + "location": "West US" + } + }, + "201": { + "body": { + "properties": { + "storageAccountId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType": "Import", + "returnAddress": { + "recipientName": "Test", + "streetAddress1": "Street1", + "streetAddress2": "street2", + "city": "Redmond", + "stateOrProvince": "wa", + "postalCode": "98007", + "countryOrRegion": "USA", + "phone": "4250000000", + "email": "Test@contoso.com" + }, + "returnShipping": { + "carrierName": "FedEx", + "carrierAccountNumber": "989ffff" + }, + "shippingInformation": { + "recipientName": "Microsoft Azure Import/Export Service", + "streetAddress1": "2045 Lafayette Street", + "streetAddress2": "", + "city": "Santa Clara", + "stateOrProvince": "CA", + "postalCode": "95050", + "countryOrRegion": "USA", + "phone": "408 0000 0000", + "additionalInformation": "" + }, + "diagnosticsPath": "waimportexport", + "logLevel": "Verbose", + "backupDriveManifest": true, + "cancelRequested": false, + "state": "Creating", + "driveList": [ + { + "driveId": "9CA995BB", + "manifestFile": "\\8a0c23f7-14b7-470a-9633-fcd46590a1bc.manifest", + "manifestHash": "4228EC5D8E048CB9B515338C789314BE8D0B2FDBC7C7A0308E1C826242CDE74E", + "driveHeaderHash": "0:1048576:FB6B6ED500D49DA6E0D723C98D42C657F2881CC13357C28DCECA6A524F1292501571A321238540E621AB5BD9C9A32637615919A75593E6CB5C1515DAE341CABF;135266304:143360:C957A189AFC38C4E80731252301EB91427CE55E61448FA3C73C6FDDE70ABBC197947EC8D0249A2C639BB10B95957D5820A4BE8DFBBF76FFFA688AE5CE0D42EC3", + "state": "Specified" + } + ], + "provisioningState": "Succeeded", + "encryptionKey": { + "kekType": "MicrosoftManaged" + } + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ImportExport/jobs/myJob", + "name": "myJob", + "type": "Microsoft.ImportExport/jobs", + "location": "West US" + } + } + } +} diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/DeleteJob.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/DeleteJob.json new file mode 100644 index 000000000000..d69a85e6b1f6 --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/DeleteJob.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2020-08-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "jobName": "myJob" + }, + "responses": { + "200": {} + } +} diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/GetExportJob.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/GetExportJob.json new file mode 100644 index 000000000000..5325f74af9c1 --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/GetExportJob.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2020-08-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "jobName": "myJob" + }, + "responses": { + "200": { + "body": { + "properties": { + "storageAccountId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType": "Export", + "returnAddress": { + "recipientName": "Test", + "streetAddress1": "Street1", + "streetAddress2": "street2", + "city": "Redmond", + "stateOrProvince": "wa", + "postalCode": "98007", + "countryOrRegion": "USA", + "phone": "4250000000", + "email": "Test@contoso.com" + }, + "returnShipping": { + "carrierName": "FedEx", + "carrierAccountNumber": "989ffff" + }, + "shippingInformation": { + "recipientName": "Microsoft Azure Import/Export Service", + "streetAddress1": "2045 Lafayette Street", + "streetAddress2": "", + "city": "Santa Clara", + "stateOrProvince": "CA", + "postalCode": "95050", + "countryOrRegion": "USA", + "phone": "408 0000 0000", + "additionalInformation": "" + }, + "diagnosticsPath": "waimportexport", + "logLevel": "Verbose", + "backupDriveManifest": true, + "cancelRequested": false, + "state": "Creating", + "driveList": [], + "export": { + "blobList": { + "blobPathPrefix": [ + "/" + ] + } + }, + "provisioningState": "Succeeded", + "encryptionKey": { + "kekType": "MicrosoftManaged" + } + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ImportExport/jobs/test", + "name": "myJob", + "type": "Microsoft.ImportExport/jobs", + "location": "West US" + } + } + } +} diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/GetJob.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/GetJob.json new file mode 100644 index 000000000000..3cce5366748c --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/GetJob.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2020-08-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "jobName": "myJob" + }, + "responses": { + "200": { + "body": { + "properties": { + "storageAccountId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType": "Import", + "returnAddress": { + "recipientName": "Test", + "streetAddress1": "Street1", + "streetAddress2": "street2", + "city": "Redmond", + "stateOrProvince": "wa", + "postalCode": "98007", + "countryOrRegion": "USA", + "phone": "4250000000", + "email": "Test@contoso.com" + }, + "returnShipping": { + "carrierName": "FedEx", + "carrierAccountNumber": "989ffff" + }, + "shippingInformation": { + "recipientName": "Microsoft Azure Import/Export Service", + "streetAddress1": "2045 Lafayette Street", + "streetAddress2": "", + "city": "Santa Clara", + "stateOrProvince": "CA", + "postalCode": "95050", + "countryOrRegion": "USA", + "phone": "408 0000 0000", + "additionalInformation": "" + }, + "diagnosticsPath": "waimportexport", + "logLevel": "Verbose", + "backupDriveManifest": true, + "cancelRequested": false, + "state": "Creating", + "driveList": [ + { + "driveId": "9CA995BB", + "manifestFile": "\\DriveManifest.xml", + "manifestHash": "109B21108597EF36D5785F08303F3638", + "driveHeaderHash": "", + "state": "Specified" + } + ], + "provisioningState": "Succeeded", + "encryptionKey": { + "kekType": "MicrosoftManaged" + } + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ImportExport/jobs/test", + "name": "myJob", + "type": "Microsoft.ImportExport/jobs", + "location": "West US" + } + } + } +} diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/GetLocation.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/GetLocation.json new file mode 100644 index 000000000000..bc47468af2d1 --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/GetLocation.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2020-08-01", + "locationName": "West US" + }, + "responses": { + "200": { + "body": { + "properties": { + "recipientName": "Microsoft Azure Import/Export Service", + "streetAddress1": "2045 Lafayette Street", + "streetAddress2": "", + "city": "Santa Clara", + "stateOrProvince": "CA", + "postalCode": "95050", + "countryOrRegion": "USA", + "phone": "408 352 7600", + "supportedCarriers": [ + "FedEx" + ], + "alternateLocations": [ + "/providers/Microsoft.ImportExport/locations/westus" + ] + }, + "id": "/providers/Microsoft.ImportExport/locations/westus", + "name": "West US", + "type": "Microsoft.ImportExport/locations" + } + } + } +} diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListBitLockerKeys.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListBitLockerKeys.json new file mode 100644 index 000000000000..3b3e8b3ff686 --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListBitLockerKeys.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2020-08-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "jobName": "myJob" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "driveId": "9CA995BB", + "bitLockerKey": "000000-000000-111111-222222-333333-444444-555555-666666" + } + ] + } + } + } +} diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListJobsInResourceGroup.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListJobsInResourceGroup.json new file mode 100644 index 000000000000..ceb96820992a --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListJobsInResourceGroup.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2020-08-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "storageAccountId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicStorage/storageAccounts/xtprodtestwu", + "jobType": "Import", + "returnAddress": { + "recipientName": "La", + "streetAddress1": "Street1", + "streetAddress2": "street2", + "city": "Redmond", + "stateOrProvince": "wa", + "postalCode": "98007", + "countryOrRegion": "USA", + "phone": "4250000000", + "email": "test@contoso.com" + }, + "returnShipping": { + "carrierName": "FedEx", + "carrierAccountNumber": "989ffff" + }, + "shippingInformation": { + "recipientName": "Microsoft Azure Import/Export Service", + "streetAddress1": "2045 Lafayette Street", + "streetAddress2": "", + "city": "Santa Clara", + "stateOrProvince": "CA", + "postalCode": "95050", + "countryOrRegion": "USA", + "phone": "408 352 7600", + "additionalInformation": "" + }, + "deliveryPackage": { + "carrierName": "FedEx", + "trackingNumber": "787895108176", + "driveCount": 1, + "shipDate": "9/29/2017 10:28:35 PM" + }, + "diagnosticsPath": "waimportexport", + "logLevel": "Verbose", + "backupDriveManifest": true, + "cancelRequested": false, + "state": "Received", + "provisioningState": "Succeeded", + "encryptionKey": { + "kekType": "MicrosoftManaged" + } + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ImportExport/jobs/test-by1-ssd-2", + "name": "test-by1-ssd-2", + "type": "Microsoft.ImportExport/jobs", + "location": "West US" + } + ] + } + } + } +} diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListJobsInSubscription.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListJobsInSubscription.json new file mode 100644 index 000000000000..eacade5d32d9 --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListJobsInSubscription.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "api-version": "2020-08-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "storageAccountId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/xtprodtestarmos2", + "jobType": "Import", + "returnAddress": { + "recipientName": "La", + "streetAddress1": "Street1", + "streetAddress2": "street2", + "city": "city", + "stateOrProvince": "wa", + "postalCode": "98007", + "countryOrRegion": "USA", + "phone": "425000000", + "email": "test@contoso.com" + }, + "returnShipping": { + "carrierName": "FedEx", + "carrierAccountNumber": "989ffff" + }, + "shippingInformation": { + "recipientName": "Windows Azure Import Export Service", + "streetAddress1": "Boydton 1 / BLDG # 1 101 Herbert Drive", + "streetAddress2": "", + "city": "Boydton", + "stateOrProvince": "VA", + "postalCode": "23917", + "countryOrRegion": "USA", + "phone": "+1-434-738-9443", + "additionalInformation": "" + }, + "deliveryPackage": { + "carrierName": "FedEx", + "trackingNumber": "992016102507", + "driveCount": 1, + "shipDate": "8/11/2017 9:05:00 PM" + }, + "diagnosticsPath": "waimportexport", + "logLevel": "Verbose", + "backupDriveManifest": true, + "cancelRequested": false, + "state": "Received", + "driveList": [ + { + "driveId": "7PHR882C", + "manifestFile": "\\DriveManifest.xml", + "manifestHash": "E5D632DB047C74B3B17C8F3359950ADB", + "state": "Received" + } + ], + "provisioningState": "Succeeded", + "encryptionKey": { + "kekType": "MicrosoftManaged" + } + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.ImportExport/jobs/test-bn1-import-cpu100-01", + "name": "test-bn1-import-cpu100-01", + "type": "Microsoft.ImportExport/jobs", + "location": "East US 2" + }, + { + "properties": { + "storageAccountId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.Storage/storageAccounts/xtprodtestarmos2", + "jobType": "Import", + "returnAddress": { + "recipientName": "La", + "streetAddress1": "Street1", + "streetAddress2": "street2", + "city": "city", + "stateOrProvince": "wa", + "postalCode": "98007", + "countryOrRegion": "USA", + "phone": "4256150991", + "email": "test@contoso.com" + }, + "shippingInformation": { + "recipientName": "Windows Azure Import Export Service", + "streetAddress1": "Boydton 1 / BLDG # 1 101 Herbert Drive", + "streetAddress2": "", + "city": "Boydton", + "stateOrProvince": "VA", + "postalCode": "23917", + "countryOrRegion": "USA", + "phone": "+1-434-738-9443", + "additionalInformation": "" + }, + "deliveryPackage": { + "carrierName": "FedEx", + "trackingNumber": "992016102508", + "driveCount": 1, + "shipDate": "8/13/2017 7:32:23 PM" + }, + "diagnosticsPath": "waimportexport", + "logLevel": "Verbose", + "backupDriveManifest": true, + "cancelRequested": false, + "state": "Transferring", + "percentComplete": 6, + "driveList": [ + { + "driveId": "KV6H86XP", + "manifestFile": "\\DriveManifest.xml", + "manifestHash": "F6A488A65AF0CCA7D050B7F9F43A197C", + "state": "CompletedMoreInfo", + "copyStatus": "InProgress", + "verboseLogUri": "https://foo.blob.core.windows.net/waimportexport/waies/test-bn1-import-cpu100-02_KV6H86XP_20170813-194618-350_verbose.xml", + "errorLogUri": "https://foo.blob.core.windows.net/waimportexport/waies/test-bn1-import-cpu100-02_KV6H86XP_20170813-194620-021_error.xml", + "manifestUri": "https://foo.blob.core.windows.net/waimportexport/waies/test-bn1-import-cpu100-02_KV6H86XP_20170813-194620-574_manifest.xml" + } + ], + "provisioningState": "Succeeded", + "encryptionKey": { + "kekType": "MicrosoftManaged" + } + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.ImportExport/jobs/test-bn1-import-cpu100-02", + "name": "test-bn1-import-cpu100-02", + "type": "Microsoft.ImportExport/jobs", + "location": "East US 2" + } + ] + } + } + } +} diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListLocations.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListLocations.json new file mode 100644 index 000000000000..ac29583c03b1 --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListLocations.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2020-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "recipientName": "Windows Azure Import/Export Service", + "streetAddress1": "Customer-A c/o NEXTDC Ltd, Delivery code ABCDEFG, 4 Eden Park Drive", + "streetAddress2": "", + "city": "Macquarie Park", + "stateOrProvince": "NSW", + "postalCode": "2113", + "countryOrRegion": "Australia", + "phone": "612 0000 0000", + "supportedCarriers": [ + "DHL" + ], + "alternateLocations": [ + "/providers/Microsoft.ImportExport/locations/australiaeast" + ] + }, + "id": "/providers/Microsoft.ImportExport/locations/australiaeast", + "name": "Australia East", + "type": "Microsoft.ImportExport/locations" + }, + { + "properties": { + "recipientName": "Microsoft Azure Import/Export Service", + "streetAddress1": "Microsoft, c/o NEXTDC Ltd, Delivery code ABCDEFG, 826-830 Lorimer St, Port", + "streetAddress2": "", + "city": "Melbourne", + "stateOrProvince": "Melbourne", + "postalCode": "3207", + "countryOrRegion": "Australia", + "phone": "61 0 0000 0000", + "supportedCarriers": [ + "DHL" + ], + "alternateLocations": [ + "/providers/Microsoft.ImportExport/locations/australiasoutheast" + ] + }, + "id": "/providers/Microsoft.ImportExport/locations/australiasoutheast", + "name": "Australia Southeast", + "type": "Microsoft.ImportExport/locations" + } + ] + } + } + } +} diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListOperations.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListOperations.json new file mode 100644 index 000000000000..002904d9a2f6 --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/ListOperations.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2020-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ImportExport/locations/read", + "display": { + "provider": "Microsoft Import/Export", + "resource": "Locations", + "operation": "Get or List Locations", + "description": "Gets the properties for the specified location or returns the list of locations." + } + }, + { + "name": "Microsoft.ImportExport/jobs/write", + "display": { + "provider": "Microsoft Import/Export", + "resource": "Jobs", + "operation": "Create or Update Job", + "description": "Creates a job with the specified parameters or update the properties or tags for the specified job." + } + }, + { + "name": "Microsoft.ImportExport/jobs/read", + "display": { + "provider": "Microsoft Import/Export", + "resource": "Jobs", + "operation": "Get or List Jobs", + "description": "Gets the properties for the specified job or returns the list of jobs." + } + }, + { + "name": "Microsoft.ImportExport/jobs/listBitLockerKeys/action", + "display": { + "provider": "Microsoft Import/Export", + "resource": "Jobs", + "operation": "List BitLocker Keys", + "description": "Gets the BitLocker keys for the specified job." + } + }, + { + "name": "Microsoft.ImportExport/jobs/delete", + "display": { + "provider": "Microsoft Import/Export", + "resource": "Jobs", + "operation": "Delete Job", + "description": "Deletes an existing job." + } + }, + { + "name": "Microsoft.ImportExport/register/action", + "display": { + "provider": "Microsoft Import/Export", + "resource": "Import/Export Resource Provider", + "operation": "Registers the Import/Export Resource Provider", + "description": "Registers the subscription for the import/export resource provider and enables the creation of import/export jobs." + } + } + ] + } + } + } +} diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/UpdateExportJob.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/UpdateExportJob.json new file mode 100644 index 000000000000..54cddee5bc00 --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/UpdateExportJob.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2020-08-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "jobName": "myExportJob", + "body": { + "properties": { + "state": "", + "logLevel": "Verbose", + "backupDriveManifest": true + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageAccountId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType": "Export", + "returnAddress": { + "recipientName": "Test", + "streetAddress1": "Street1", + "streetAddress2": "street2", + "city": "Redmond", + "stateOrProvince": "wa", + "postalCode": "98007", + "countryOrRegion": "USA", + "phone": "4250000000", + "email": "Test@contoso.com" + }, + "returnShipping": { + "carrierName": "FedEx", + "carrierAccountNumber": "989ffff" + }, + "shippingInformation": { + "recipientName": "Microsoft Azure Import/Export Service", + "streetAddress1": "2045 Lafayette Street", + "streetAddress2": "", + "city": "Santa Clara", + "stateOrProvince": "CA", + "postalCode": "95050", + "countryOrRegion": "USA", + "phone": "408 352 7600", + "additionalInformation": "" + }, + "diagnosticsPath": "waimportexport", + "logLevel": "Verbose", + "backupDriveManifest": true, + "cancelRequested": false, + "state": "Creating", + "export": { + "blobList": { + "blobPathPrefix": [ + "/" + ] + } + }, + "provisioningState": "Succeeded", + "encryptionKey": { + "kekType": "MicrosoftManaged" + } + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ImportExport/jobs/myExportJob", + "name": "myExportJob", + "type": "Microsoft.ImportExport/jobs", + "location": "West US" + } + } + } +} diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/UpdateJob.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/UpdateJob.json new file mode 100644 index 000000000000..df0e42281026 --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/examples/UpdateJob.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2020-08-01", + "subscriptionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "resourceGroupName": "myResourceGroup", + "jobName": "myJob", + "body": { + "properties": { + "state": "", + "logLevel": "Verbose", + "backupDriveManifest": true + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageAccountId": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ClassicStorage/storageAccounts/test", + "jobType": "Import", + "returnAddress": { + "recipientName": "Test", + "streetAddress1": "Street1", + "streetAddress2": "street2", + "city": "Redmond", + "stateOrProvince": "wa", + "postalCode": "98007", + "countryOrRegion": "USA", + "phone": "4250000000", + "email": "Test@contoso.com" + }, + "returnShipping": { + "carrierName": "FedEx", + "carrierAccountNumber": "989ffff" + }, + "shippingInformation": { + "recipientName": "Microsoft Azure Import/Export Service", + "streetAddress1": "2045 Lafayette Street", + "streetAddress2": "", + "city": "Santa Clara", + "stateOrProvince": "CA", + "postalCode": "95050", + "countryOrRegion": "USA", + "phone": "408 352 7600", + "additionalInformation": "" + }, + "diagnosticsPath": "waimportexport", + "logLevel": "Verbose", + "backupDriveManifest": true, + "cancelRequested": false, + "state": "Creating", + "driveList": [ + { + "driveId": "9CA995BB", + "manifestFile": "\\8a0c23f7-14b7-470a-9633-fcd46590a1bc.manifest", + "manifestHash": "4228EC5D8E048CB9B515338C789314BE8D0B2FDBC7C7A0308E1C826242CDE74E", + "driveHeaderHash": "0:1048576:FB6B6ED500D49DA6E0D723C98D42C657F2881CC13357C28DCECA6A524F1292501571A321238540E621AB5BD9C9A32637615919A75593E6CB5C1515DAE341CABF;135266304:143360:C957A189AFC38C4E80731252301EB91427CE55E61448FA3C73C6FDDE70ABBC197947EC8D0249A2C639BB10B95957D5820A4BE8DFBBF76FFFA688AE5CE0D42EC3", + "state": "Specified" + } + ], + "provisioningState": "Succeeded", + "encryptionKey": { + "kekType": "MicrosoftManaged" + } + }, + "identity": { + "type": "None" + }, + "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ImportExport/jobs/myJob", + "name": "myJob", + "type": "Microsoft.ImportExport/jobs", + "location": "West US" + } + } + } +} diff --git a/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/storageimportexport.json b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/storageimportexport.json new file mode 100644 index 000000000000..1fec719ac62a --- /dev/null +++ b/specification/storageimportexport/resource-manager/Microsoft.ImportExport/stable/2020-08-01/storageimportexport.json @@ -0,0 +1,1313 @@ +{ + "swagger": "2.0", + "info": { + "title": "StorageImportExport", + "description": "The Storage Import/Export Resource Provider API.", + "version": "2020-08-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.ImportExport/locations": { + "get": { + "tags": [ + "StorageImportExport" + ], + "operationId": "Locations_List", + "description": "Returns a list of locations to which you can ship the disks associated with an import or export job. A location is a Microsoft data center region.", + "x-ms-examples": { + "List locations": { + "$ref": "examples/ListLocations.json" + } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LocationsResponse" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ImportExport/locations/{locationName}": { + "get": { + "tags": [ + "StorageImportExport" + ], + "operationId": "Locations_Get", + "description": "Returns the details about a location to which you can ship the disks associated with an import or export job. A location is an Azure region.", + "x-ms-examples": { + "Get locations": { + "$ref": "examples/GetLocation.json" + } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "name": "locationName", + "in": "path", + "description": "The name of the location. For example, West US or westus.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Location" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ImportExport/jobs": { + "get": { + "tags": [ + "StorageImportExport" + ], + "operationId": "Jobs_ListBySubscription", + "description": "Returns all active and completed jobs in a subscription.", + "x-ms-examples": { + "List jobs in a subscription": { + "$ref": "examples/ListJobsInSubscription.json" + } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "name": "$top", + "in": "query", + "description": "An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100.", + "required": false, + "type": "integer" + }, + { + "name": "$filter", + "in": "query", + "description": "Can be used to restrict the results to certain conditions.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListJobsResponse" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs": { + "get": { + "tags": [ + "StorageImportExport" + ], + "operationId": "Jobs_ListByResourceGroup", + "description": "Returns all active and completed jobs in a resource group.", + "x-ms-examples": { + "List jobs in a resource group": { + "$ref": "examples/ListJobsInResourceGroup.json" + } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "name": "$top", + "in": "query", + "description": "An integer value that specifies how many jobs at most should be returned. The value cannot exceed 100.", + "required": false, + "type": "integer" + }, + { + "name": "$filter", + "in": "query", + "description": "Can be used to restrict the results to certain conditions.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListJobsResponse" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}": { + "get": { + "tags": [ + "StorageImportExport" + ], + "operationId": "Jobs_Get", + "description": "Gets information about an existing job.", + "x-ms-examples": { + "Get import job": { + "$ref": "examples/GetJob.json" + }, + "Get export job": { + "$ref": "examples/GetExportJob.json" + } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "name": "jobName", + "in": "path", + "description": "The name of the import/export job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "StorageImportExport" + ], + "operationId": "Jobs_Update", + "description": "Updates specific properties of a job. You can call this operation to notify the Import/Export service that the hard drives comprising the import or export job have been shipped to the Microsoft data center. It can also be used to cancel an existing job.", + "x-ms-examples": { + "Update import job": { + "$ref": "examples/UpdateJob.json" + }, + "Update export job": { + "$ref": "examples/UpdateExportJob.json" + } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "name": "jobName", + "in": "path", + "description": "The name of the import/export job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/Accept-Language" + }, + { + "name": "body", + "in": "body", + "required": true, + "description": "The parameters to update in the job", + "schema": { + "$ref": "#/definitions/UpdateJobParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "StorageImportExport" + ], + "operationId": "Jobs_Create", + "description": "Creates a new job or updates an existing job in the specified subscription.", + "x-ms-examples": { + "Create import job": { + "$ref": "examples/CreateJob.json" + }, + "Create export job": { + "$ref": "examples/CreateExportJob.json" + } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "name": "jobName", + "in": "path", + "description": "The name of the import/export job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/Accept-Language" + }, + { + "$ref": "#/parameters/x-ms-client-tenant-id" + }, + { + "name": "body", + "in": "body", + "description": "The parameters used for creating the job", + "required": true, + "schema": { + "$ref": "#/definitions/PutJobParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "StorageImportExport" + ], + "operationId": "Jobs_Delete", + "description": "Deletes an existing job. Only jobs in the Creating or Completed states can be deleted.", + "x-ms-examples": { + "Delete job": { + "$ref": "examples/DeleteJob.json" + } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "name": "jobName", + "in": "path", + "description": "The name of the import/export job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ImportExport/jobs/{jobName}/listBitLockerKeys": { + "post": { + "tags": [ + "StorageImportExport" + ], + "operationId": "BitLockerKeys_List", + "description": "Returns the BitLocker Keys for all drives in the specified job.", + "x-ms-examples": { + "List BitLocker Keys for drives in a job": { + "$ref": "examples/ListBitLockerKeys.json" + } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "name": "jobName", + "in": "path", + "description": "The name of the import/export job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GetBitLockerKeysResponse" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.ImportExport/operations": { + "get": { + "tags": [ + "StorageImportExport" + ], + "operationId": "Operations_List", + "description": "Returns the list of operations supported by the import/export resource provider.", + "x-ms-examples": { + "List available operations": { + "$ref": "examples/ListOperations.json" + } + }, + "externalDocs": { + "url": "" + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/Accept-Language" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListOperationsResponse" + } + }, + "default": { + "description": "An error occurs.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "ErrorResponse": { + "description": "Response when errors occurred", + "properties": { + "error": { + "x-ms-client-flatten": true, + "description": "Describes the error information.", + "properties": { + "code": { + "type": "string", + "description": "Provides information about the error code." + }, + "message": { + "type": "string", + "description": "Provides information about the error message." + }, + "target": { + "type": "string", + "description": "Provides information about the error target." + }, + "details": { + "type": "array", + "description": "Describes the error details if present.", + "items": { + "properties": { + "code": { + "type": "string", + "description": "Provides information about the error code." + }, + "target": { + "type": "string", + "description": "Provides information about the error target." + }, + "message": { + "type": "string", + "description": "Provides information about the error message." + } + } + } + }, + "innererror": { + "type": "object", + "description": "Inner error object if present." + } + } + } + } + }, + "PutJobParameters": { + "description": "Put Job parameters", + "properties": { + "location": { + "type": "string", + "description": "Specifies the supported Azure location where the job should be created" + }, + "tags": { + "type": "object", + "description": "Specifies the tags that will be assigned to the job." + }, + "properties": { + "$ref": "#/definitions/JobDetails", + "description": "Specifies the job properties" + } + } + }, + "JobDetails": { + "description": "Specifies the job properties", + "properties": { + "storageAccountId": { + "type": "string", + "description": "The resource identifier of the storage account where data will be imported to or exported from." + }, + "jobType": { + "type": "string", + "description": "The type of job" + }, + "returnAddress": { + "description": "Specifies the return address information for the job. ", + "$ref": "#/definitions/ReturnAddress" + }, + "returnShipping": { + "description": "Specifies the return carrier and customer's account with the carrier. ", + "$ref": "#/definitions/ReturnShipping" + }, + "shippingInformation": { + "description": "Contains information about the Microsoft datacenter to which the drives should be shipped. ", + "$ref": "#/definitions/ShippingInformation" + }, + "deliveryPackage": { + "description": "Contains information about the package being shipped by the customer to the Microsoft data center. ", + "$ref": "#/definitions/PackageInformation" + }, + "returnPackage": { + "description": "Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned. ", + "$ref": "#/definitions/PackageInformation" + }, + "diagnosticsPath": { + "type": "string", + "description": "The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored." + }, + "logLevel": { + "type": "string", + "description": "Default value is Error. Indicates whether error logging or verbose logging will be enabled." + }, + "backupDriveManifest": { + "type": "boolean", + "description": "Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs." + }, + "state": { + "type": "string", + "description": "Current state of the job." + }, + "cancelRequested": { + "type": "boolean", + "description": "Indicates whether a request has been submitted to cancel the job." + }, + "percentComplete": { + "type": "integer", + "description": "Overall percentage completed for the job." + }, + "incompleteBlobListUri": { + "type": "string", + "description": "A blob path that points to a block blob containing a list of blob names that were not exported due to insufficient drive space. If all blobs were exported successfully, then this element is not included in the response." + }, + "driveList": { + "description": "List of up to ten drives that comprise the job. The drive list is a required element for an import job; it is not specified for export jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/DriveStatus" + } + }, + "export": { + "description": "A property containing information about the blobs to be exported for an export job. This property is included for export jobs only.", + "$ref": "#/definitions/Export" + }, + "provisioningState": { + "type": "string", + "description": "Specifies the provisioning state of the job." + }, + "encryptionKey": { + "description": "Contains information about the encryption key.", + "$ref": "#/definitions/EncryptionKeyDetails" + } + } + }, + "EncryptionKeyDetails": { + "description": "Specifies the encryption key properties", + "properties": { + "kekType": { + "type": "string", + "description": "The type of kek encryption key", + "default": "MicrosoftManaged", + "enum": [ + "MicrosoftManaged", + "CustomerManaged" + ] + }, + "kekUrl": { + "description": "Specifies the url for kek encryption key. ", + "type": "string" + }, + "kekVaultResourceID": { + "description": "Specifies the keyvault resource id for kek encryption key. ", + "type": "string" + } + } + }, + "IdentityDetails": { + "description": "Specifies the identity properties. ", + "properties": { + "type": { + "type": "string", + "description": "The type of identity", + "default": "None", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ] + }, + "principalId": { + "description": "Specifies the principal id for the identity for the job. ", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Specifies the tenant id for the identity for the job. ", + "type": "string", + "readOnly": true + } + } + }, + "UpdateJobParameters": { + "description": "Update Job parameters", + "properties": { + "tags": { + "type": "object", + "description": "Specifies the tags that will be assigned to the job" + }, + "properties": { + "x-ms-client-flatten": true, + "properties": { + "cancelRequested": { + "type": "boolean", + "description": "If specified, the value must be true. The service will attempt to cancel the job. " + }, + "state": { + "type": "string", + "description": "If specified, the value must be Shipping, which tells the Import/Export service that the package for the job has been shipped. The ReturnAddress and DeliveryPackage properties must have been set either in this request or in a previous request, otherwise the request will fail. " + }, + "returnAddress": { + "description": "Specifies the return address information for the job.", + "$ref": "#/definitions/ReturnAddress" + }, + "returnShipping": { + "description": "Specifies the return carrier and customer's account with the carrier.", + "$ref": "#/definitions/ReturnShipping" + }, + "deliveryPackage": { + "description": "Contains information about the package being shipped by the customer to the Microsoft data center.", + "$ref": "#/definitions/PackageInformation" + }, + "logLevel": { + "type": "string", + "description": "Indicates whether error logging or verbose logging is enabled." + }, + "backupDriveManifest": { + "type": "boolean", + "description": "Indicates whether the manifest files on the drives should be copied to block blobs." + }, + "driveList": { + "description": "List of drives that comprise the job.", + "type": "array", + "items": { + "$ref": "#/definitions/DriveStatus" + } + } + }, + "description": "Specifies the properties of a UpdateJob." + } + } + }, + "ListJobsResponse": { + "description": "List jobs response", + "properties": { + "nextLink": { + "type": "string", + "description": "link to next batch of jobs" + }, + "value": { + "type": "array", + "description": "Job list", + "items": { + "$ref": "#/definitions/JobResponse" + } + } + } + }, + "JobResponse": { + "x-ms-azure-resource": true, + "description": "Contains the job information.", + "properties": { + "id": { + "type": "string", + "description": "Specifies the resource identifier of the job.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Specifies the name of the job.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Specifies the type of the job resource.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Specifies the Azure location where the job is created." + }, + "tags": { + "type": "object", + "description": "Specifies the tags that are assigned to the job." + }, + "properties": { + "$ref": "#/definitions/JobDetails", + "description": "Specifies the job properties" + }, + "identity": { + "$ref": "#/definitions/IdentityDetails", + "description": "Specifies the job identity details" + } + } + }, + "Operation": { + "description": "Describes a supported operation by the Storage Import/Export job API.", + "required": [ + "name", + "display" + ], + "properties": { + "name": { + "type": "string", + "description": "Name of the operation." + }, + "display": { + "x-ms-client-flatten": true, + "description": "operation display properties", + "properties": { + "provider": { + "type": "string", + "description": "The resource provider name to which the operation belongs." + }, + "resource": { + "type": "string", + "description": "The name of the resource to which the operation belongs." + }, + "operation": { + "type": "string", + "description": "The display name of the operation." + }, + "description": { + "type": "string", + "description": "Short description of the operation." + } + } + } + } + }, + "Location": { + "description": "Provides information about an Azure data center location.", + "properties": { + "id": { + "description": "Specifies the resource identifier of the location. ", + "type": "string" + }, + "name": { + "description": "Specifies the name of the location. Use List Locations to get all supported locations. ", + "type": "string" + }, + "type": { + "description": "Specifies the type of the location. ", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "location properties", + "properties": { + "recipientName": { + "description": "The recipient name to use when shipping the drives to the Azure data center. ", + "type": "string" + }, + "streetAddress1": { + "description": "The first line of the street address to use when shipping the drives to the Azure data center. ", + "type": "string" + }, + "streetAddress2": { + "description": "The second line of the street address to use when shipping the drives to the Azure data center. ", + "type": "string" + }, + "city": { + "description": "The city name to use when shipping the drives to the Azure data center. ", + "type": "string" + }, + "stateOrProvince": { + "description": "The state or province to use when shipping the drives to the Azure data center. ", + "type": "string" + }, + "postalCode": { + "description": "The postal code to use when shipping the drives to the Azure data center. ", + "type": "string" + }, + "countryOrRegion": { + "description": "The country or region to use when shipping the drives to the Azure data center. ", + "type": "string" + }, + "phone": { + "description": "The phone number for the Azure data center. ", + "type": "string" + }, + "supportedCarriers": { + "type": "array", + "description": "A list of carriers that are supported at this location. ", + "items": { + "type": "string" + } + }, + "alternateLocations": { + "type": "array", + "description": "A list of location IDs that should be used to ship shipping drives to for jobs created against the current location. If the current location is active, it will be part of the list. If it is temporarily closed due to maintenance, this list may contain other locations. ", + "items": { + "type": "string" + } + } + } + } + } + }, + "ReturnAddress": { + "description": "Specifies the return address information for the job.", + "required": [ + "recipientName", + "streetAddress1", + "city", + "postalCode", + "countryOrRegion", + "phone", + "email" + ], + "properties": { + "recipientName": { + "type": "string", + "description": "The name of the recipient who will receive the hard drives when they are returned. " + }, + "streetAddress1": { + "type": "string", + "description": "The first line of the street address to use when returning the drives. " + }, + "streetAddress2": { + "type": "string", + "description": "The second line of the street address to use when returning the drives. " + }, + "city": { + "type": "string", + "description": "The city name to use when returning the drives." + }, + "stateOrProvince": { + "type": "string", + "description": "The state or province to use when returning the drives." + }, + "postalCode": { + "type": "string", + "description": "The postal code to use when returning the drives." + }, + "countryOrRegion": { + "type": "string", + "description": "The country or region to use when returning the drives. " + }, + "phone": { + "type": "string", + "description": "Phone number of the recipient of the returned drives." + }, + "email": { + "type": "string", + "description": "Email address of the recipient of the returned drives." + } + } + }, + "ReturnShipping": { + "description": "Specifies the return carrier and customer's account with the carrier.", + "required": [ + "carrierName", + "carrierAccountNumber" + ], + "properties": { + "carrierName": { + "type": "string", + "description": "The carrier's name." + }, + "carrierAccountNumber": { + "type": "string", + "description": "The customer's account number with the carrier." + } + } + }, + "ShippingInformation": { + "description": "Contains information about the Microsoft datacenter to which the drives should be shipped.", + "required": [ + "recipientName", + "streetAddress1", + "city", + "stateOrProvince", + "postalCode", + "countryOrRegion" + ], + "properties": { + "recipientName": { + "type": "string", + "description": "The name of the recipient who will receive the hard drives when they are returned. " + }, + "streetAddress1": { + "type": "string", + "description": "The first line of the street address to use when returning the drives. " + }, + "streetAddress2": { + "type": "string", + "description": "The second line of the street address to use when returning the drives. " + }, + "city": { + "type": "string", + "description": "The city name to use when returning the drives." + }, + "stateOrProvince": { + "type": "string", + "description": "The state or province to use when returning the drives." + }, + "postalCode": { + "type": "string", + "description": "The postal code to use when returning the drives." + }, + "countryOrRegion": { + "type": "string", + "description": "The country or region to use when returning the drives. " + }, + "phone": { + "type": "string", + "description": "Phone number of the recipient of the returned drives." + }, + "additionalInformation": { + "type": "string", + "description": "Additional shipping information for customer, specific to datacenter to which customer should send their disks.", + "readOnly": true + } + } + }, + "PackageInformation": { + "description": "Contains information about the package being shipped by the customer to the Microsoft data center.", + "required": [ + "carrierName", + "trackingNumber", + "driveCount", + "shipDate" + ], + "properties": { + "carrierName": { + "type": "string", + "description": "The name of the carrier that is used to ship the import or export drives." + }, + "trackingNumber": { + "type": "string", + "description": "The tracking number of the package." + }, + "driveCount": { + "type": "integer", + "format": "int64", + "description": "The number of drives included in the package." + }, + "shipDate": { + "type": "string", + "description": "The date when the package is shipped." + } + } + }, + "DriveStatus": { + "description": "Provides information about the drive's status", + "properties": { + "driveId": { + "type": "string", + "description": "The drive's hardware serial number, without spaces." + }, + "bitLockerKey": { + "type": "string", + "description": "The BitLocker key used to encrypt the drive." + }, + "manifestFile": { + "type": "string", + "description": "The relative path of the manifest file on the drive. " + }, + "manifestHash": { + "type": "string", + "description": "The Base16-encoded MD5 hash of the manifest file on the drive." + }, + "driveHeaderHash": { + "type": "string", + "description": "The drive header hash value." + }, + "state": { + "type": "string", + "description": "The drive's current state. ", + "enum": [ + "Specified", + "Received", + "NeverReceived", + "Transferring", + "Completed", + "CompletedMoreInfo", + "ShippedBack" + ], + "x-ms-enum": { + "name": "DriveState", + "modelAsString": true + } + }, + "copyStatus": { + "type": "string", + "description": "Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state." + }, + "percentComplete": { + "type": "integer", + "description": "Percentage completed for the drive. " + }, + "verboseLogUri": { + "type": "string", + "description": "A URI that points to the blob containing the verbose log for the data transfer operation. " + }, + "errorLogUri": { + "type": "string", + "description": "A URI that points to the blob containing the error log for the data transfer operation." + }, + "manifestUri": { + "type": "string", + "description": "A URI that points to the blob containing the drive manifest file. " + }, + "bytesSucceeded": { + "type": "integer", + "format": "int64", + "description": "Bytes successfully transferred for the drive." + } + } + }, + "Export": { + "description": "A property containing information about the blobs to be exported for an export job. This property is required for export jobs, but must not be specified for import jobs.", + "properties": { + "blobList": { + "description": "A list of the blobs to be exported.", + "x-ms-client-flatten": true, + "properties": { + "blobPath": { + "type": "array", + "description": "A collection of blob-path strings.", + "items": { + "type": "string" + } + }, + "blobPathPrefix": { + "type": "array", + "description": "A collection of blob-prefix strings.", + "items": { + "type": "string" + } + } + } + }, + "blobListBlobPath": { + "type": "string", + "description": "The relative URI to the block blob that contains the list of blob paths or blob path prefixes as defined above, beginning with the container name. If the blob is in root container, the URI must begin with $root. " + } + } + }, + "LocationsResponse": { + "description": "Locations response", + "properties": { + "value": { + "type": "array", + "description": "locations", + "items": { + "$ref": "#/definitions/Location" + } + } + } + }, + "GetBitLockerKeysResponse": { + "description": "GetBitLockerKeys response", + "properties": { + "value": { + "type": "array", + "description": "drive status", + "items": { + "$ref": "#/definitions/DriveBitLockerKey" + } + } + } + }, + "DriveBitLockerKey": { + "description": "BitLocker recovery key or password to the specified drive", + "properties": { + "bitLockerKey": { + "type": "string", + "description": "BitLocker recovery key or password" + }, + "driveId": { + "type": "string", + "description": "Drive ID" + } + } + }, + "ListOperationsResponse": { + "description": "List operations response", + "properties": { + "value": { + "type": "array", + "description": "operations", + "items": { + "$ref": "#/definitions/Operation" + } + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "Specifies the API version to use for this request.", + "required": true, + "type": "string", + "enum": [ + "2020-08-01" + ] + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID for the Azure user.", + "required": true, + "type": "string" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name uniquely identifies the resource group within the user subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Accept-Language": { + "name": "Accept-Language", + "in": "header", + "description": "Specifies the preferred language for the response.", + "required": false, + "type": "string", + "x-ms-parameter-location": "client" + }, + "x-ms-client-tenant-id": { + "name": "x-ms-client-tenant-id", + "in": "header", + "description": "The tenant ID of the client making the request.", + "required": false, + "type": "string", + "x-ms-client-name": "ClientTenantId", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/storageimportexport/resource-manager/readme.go.md b/specification/storageimportexport/resource-manager/readme.go.md index 9b48808d7a27..28ce19ba3744 100644 --- a/specification/storageimportexport/resource-manager/readme.go.md +++ b/specification/storageimportexport/resource-manager/readme.go.md @@ -15,6 +15,12 @@ go: batch: - tag: package-2016-11 ``` +or + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2020-08 +``` ### Tag: package-2016-11 and go @@ -23,4 +29,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-08' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-08-01/$(namespace) ``` \ No newline at end of file diff --git a/specification/storageimportexport/resource-manager/readme.md b/specification/storageimportexport/resource-manager/readme.md index 7b2c9dc33212..dff85c194da0 100644 --- a/specification/storageimportexport/resource-manager/readme.md +++ b/specification/storageimportexport/resource-manager/readme.md @@ -28,7 +28,12 @@ These are the global settings for the StorageImportExport API. openapi-type: arm tag: package-2016-11 ``` +or +``` yaml +openapi-type: arm +tag: package-2020-08 +``` ### Tag: package-2016-11 @@ -39,6 +44,14 @@ input-file: - Microsoft.ImportExport/stable/2016-11-01/storageimportexport.json ``` +### Tag: package-2020-08 + +These settings apply only when `--tag=package-2020-08` is specified on the command line. + +``` yaml $(tag) == 'package-2020-08' +input-file: +- Microsoft.ImportExport/stable/2020-08-01/storageimportexport.json +``` --- # Code Generation @@ -80,6 +93,12 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storageimportexport batch: - tag: package-2016-11 ``` +or + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2020-08 +``` ### Tag: package-2016-11 and java @@ -94,6 +113,19 @@ regenerate-manager: true generate-interface: true ``` +### Tag: package-2020-08 and java + +These settings apply only when `--tag=package-2020-08 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2020-08' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.storageimportexport.v2020_08_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/storageimportexport/mgmt-v2020_08_01 +regenerate-manager: true +generate-interface: true +``` + ## Multi-API/Profile support for AutoRest v3 generators @@ -109,6 +141,7 @@ 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 ``` From 4873ee82eef44772dec2b6c26d9b5a094c393b21 Mon Sep 17 00:00:00 2001 From: Alfredo Santamaria Date: Wed, 29 Jul 2020 19:17:22 -0700 Subject: [PATCH 07/29] Fix api 2020-01-01-preview dataDiskSizeGB parameter name (#10280) * fix dataDiskSizeGB parameter name * rename ManagedClusterVersions to differentiate with non-managed model Co-authored-by: Alfredo Santamaria Gomez --- ...e.json => ManagedClusterVersionsListByOS_example.json} | 0 .../examples/NodeTypeGetOperation_example.json | 2 +- .../examples/NodeTypeListOperation_example.json | 4 ++-- .../examples/NodeTypePatchOperation_example.json | 4 ++-- .../examples/NodeTypePutOperation_example_max.json | 8 ++++---- .../examples/NodeTypePutOperation_example_min.json | 8 ++++---- .../preview/2020-01-01-preview/managedcluster.json | 6 +++--- .../preview/2020-01-01-preview/nodetype.json | 4 ++-- 8 files changed, 18 insertions(+), 18 deletions(-) rename specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/{ClusterVersionsListByOS_example.json => ManagedClusterVersionsListByOS_example.json} (100%) diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/ClusterVersionsListByOS_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/ManagedClusterVersionsListByOS_example.json similarity index 100% rename from specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/ClusterVersionsListByOS_example.json rename to specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/ManagedClusterVersionsListByOS_example.json diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypeGetOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypeGetOperation_example.json index 5cc62be5cf7d..da4b281b58b3 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypeGetOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypeGetOperation_example.json @@ -16,7 +16,7 @@ "tags": {}, "properties": { "isPrimary": true, - "diskSizeInGB": 100, + "dataDiskSizeGB": 100, "placementProperties": {}, "capacities": {}, "vmSize": "Standard_D2", diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypeListOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypeListOperation_example.json index de38b7297316..6f4b84062835 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypeListOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypeListOperation_example.json @@ -17,7 +17,7 @@ "tags": {}, "properties": { "isPrimary": true, - "diskSizeInGB": 100, + "dataDiskSizeGB": 100, "placementProperties": {}, "capacities": {}, "vmSize": "Standard_D2", @@ -35,7 +35,7 @@ "tags": {}, "properties": { "isPrimary": false, - "diskSizeInGB": 200, + "dataDiskSizeGB": 200, "placementProperties": {}, "capacities": {}, "vmSize": "Standard_D3", diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypePatchOperation_example.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypePatchOperation_example.json index 393b2122db51..65d76cff104f 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypePatchOperation_example.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypePatchOperation_example.json @@ -62,7 +62,7 @@ }, "properties": { "isPrimary": false, - "diskSizeInGB": 200, + "dataDiskSizeGB": 200, "placementProperties": { "HasSSD": "true", "NodeColor": "green", @@ -119,7 +119,7 @@ }, "properties": { "isPrimary": false, - "diskSizeInGB": 200, + "dataDiskSizeGB": 200, "placementProperties": { "HasSSD": "true", "NodeColor": "green", diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypePutOperation_example_max.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypePutOperation_example_max.json index beb9e1f7a69f..4935cda63706 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypePutOperation_example_max.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypePutOperation_example_max.json @@ -8,7 +8,7 @@ "parameters": { "properties": { "isPrimary": false, - "diskSizeInGB": 200, + "dataDiskSizeGB": 200, "placementProperties": { "HasSSD": "true", "NodeColor": "green", @@ -64,7 +64,7 @@ "tags": {}, "properties": { "isPrimary": false, - "diskSizeInGB": 200, + "dataDiskSizeGB": 200, "placementProperties": { "HasSSD": "true", "NodeColor": "green", @@ -119,7 +119,7 @@ "tags": {}, "properties": { "isPrimary": false, - "diskSizeInGB": 200, + "dataDiskSizeGB": 200, "placementProperties": { "HasSSD": "true", "NodeColor": "green", @@ -175,7 +175,7 @@ "tags": {}, "properties": { "isPrimary": false, - "diskSizeInGB": 200, + "dataDiskSizeGB": 200, "placementProperties": { "HasSSD": "true", "NodeColor": "green", diff --git a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypePutOperation_example_min.json b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypePutOperation_example_min.json index 5c78c18a91fd..81608fe06218 100644 --- a/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypePutOperation_example_min.json +++ b/specification/servicefabric/resource-manager/Microsoft.ServiceFabric/preview/2020-01-01-preview/examples/NodeTypePutOperation_example_min.json @@ -8,7 +8,7 @@ "parameters": { "properties": { "isPrimary": false, - "diskSizeInGB": 200, + "dataDiskSizeGB": 200, "vmSize": "Standard_D3", "vmImagePublisher": "MicrosoftWindowsServer", "vmImageOffer": "WindowsServer", @@ -31,7 +31,7 @@ "tags": {}, "properties": { "isPrimary": false, - "diskSizeInGB": 200, + "dataDiskSizeGB": 200, "placementProperties": {}, "capacities": {}, "vmSize": "Standard_D3", @@ -55,7 +55,7 @@ "tags": {}, "properties": { "isPrimary": false, - "diskSizeInGB": 200, + "dataDiskSizeGB": 200, "placementProperties": {}, "capacities": {}, "vmSize": "Standard_D3", @@ -79,7 +79,7 @@ "tags": {}, "properties": { "isPrimary": false, - "diskSizeInGB": 200, + "dataDiskSizeGB": 200, "placementProperties": {}, "capacities": {}, "vmSize": "Standard_D3", 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 c18b0040ebdf..b5ba10c91469 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 @@ -377,7 +377,7 @@ }, "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/managedclusters/locations/{location}/osType/{osType}/clusterVersions": { "get": { - "operationId": "ClusterVersions_ListByOS", + "operationId": "ManagedClusterVersions_ListByOS", "summary": "Gets the list of Service Fabric cluster code versions available for the specified OS type.", "description": "Gets all available code versions for Service Fabric cluster resources by OS type.", "parameters": [ @@ -396,11 +396,11 @@ ], "x-ms-examples": { "List cluster versions by OS": { - "$ref": "./examples/ClusterVersionsListByOS_example.json" + "$ref": "./examples/ManagedClusterVersionsListByOS_example.json" } }, "tags": [ - "ClusterVersion" + "ManagedClusterVersion" ], "responses": { "200": { 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 ed9a98cd3c88..04f22ffa6b1b 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 @@ -578,7 +578,7 @@ "required": [ "isPrimary", "vmInstanceCount", - "diskSizeInGB" + "dataDiskSizeGB" ], "properties": { "isPrimary": { @@ -592,7 +592,7 @@ "minimum": 1, "maximum": 2147483647 }, - "diskSizeInGB": { + "dataDiskSizeGB": { "type": "integer", "format": "int32", "description": "Disk size for each vm in the node type in GBs." From 4a8b5a45efc6071703178447cb7965be8a402a3b Mon Sep 17 00:00:00 2001 From: Arcturus Date: Thu, 30 Jul 2020 11:45:53 +0800 Subject: [PATCH 08/29] Fix hybridnetwork namespace of go SDK (#10286) * Fix hybridnetwork namespace * Fix --- .../hybridnetwork/resource-manager/readme.go.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/specification/hybridnetwork/resource-manager/readme.go.md b/specification/hybridnetwork/resource-manager/readme.go.md index d1f3880de6c2..31aa99b2c827 100644 --- a/specification/hybridnetwork/resource-manager/readme.go.md +++ b/specification/hybridnetwork/resource-manager/readme.go.md @@ -8,12 +8,19 @@ go: clear-output-folder: true ``` +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2020-01-01-preview +``` + ### Tag: package-2020-01-01-preview and go These settings apply only when `--tag=package-2020-01-01-preview --go` is specified on the command line. Please also specify `--go-sdks-folder=`. ```yaml $(tag) == 'package-2020-01-01-preview' && $(go) -namespace: Microsoft.HybridNetwork -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/management/2020-01-01-preview/$(namespace) +namespace: hybridnetwork +output-folder: $(go-sdk-folder)/services/preview/management/2020-01-01-preview/$(namespace) ``` \ No newline at end of file From b8630cc7b5869fbb764eeca3a618b23141e612db Mon Sep 17 00:00:00 2001 From: Bruce Johnston Date: Thu, 30 Jul 2020 04:06:00 +0000 Subject: [PATCH 09/29] [Azure Cognitive Search] Add missing x-nullable annotations, part 2 (#10293) * [Azure Cognitive Search] Add missing x-nullable annotations, part 2 Fixes https://github.com/Azure/azure-rest-api-specs/issues/10226 * [Azure Cognitive Search] Fix example causing validation error Co-authored-by: Bruce Johnston --- .../2020-06-30-Preview/searchservice.json | 27 ++++++++++++------- .../SearchServiceGetServiceStatistics.json | 4 --- .../preview/2020-06-30/searchservice.json | 27 ++++++++++++------- 3 files changed, 36 insertions(+), 22 deletions(-) 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 3e28f11192a4..ff607b71c3b9 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 @@ -5518,12 +5518,14 @@ "k1": { "type": "number", "format": "double", - "description": "This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency." + "description": "This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency.", + "x-nullable": true }, "b": { "type": "number", "format": "double", - "description": "This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document." + "description": "This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document.", + "x-nullable": true } }, "description": "Ranking function based on the Okapi BM25 similarity algorithm. BM25 is a TF-IDF-like algorithm that includes length normalization (controlled by the 'b' parameter) as well as term frequency saturation (controlled by the 'k1' parameter)." @@ -6246,21 +6248,24 @@ "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" }, "$ref": "#/definitions/LexicalAnalyzerName", - "description": "The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields." + "description": "The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.", + "x-nullable": true }, "searchAnalyzer": { "externalDocs": { "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" }, "$ref": "#/definitions/LexicalAnalyzerName", - "description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields." + "description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields.", + "x-nullable": true }, "indexAnalyzer": { "externalDocs": { "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" }, "$ref": "#/definitions/LexicalAnalyzerName", - "description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields." + "description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.", + "x-nullable": true }, "synonymMaps": { "externalDocs": { @@ -6540,7 +6545,8 @@ "text": { "x-ms-client-name": "TextWeights", "$ref": "#/definitions/TextWeights", - "description": "Parameters that boost scoring based on text matches in certain index fields." + "description": "Parameters that boost scoring based on text matches in certain index fields.", + "x-nullable": true }, "functions": { "type": "array", @@ -6695,7 +6701,8 @@ }, "corsOptions": { "$ref": "#/definitions/CorsOptions", - "description": "Options to control Cross-Origin Resource Sharing (CORS) for the index." + "description": "Options to control Cross-Origin Resource Sharing (CORS) for the index.", + "x-nullable": true }, "suggesters": { "type": "array", @@ -6749,7 +6756,8 @@ "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", "externalDocs": { "url": "https://aka.ms/azure-search-encryption-with-cmk" - } + }, + "x-nullable": true }, "similarity": { "$ref": "#/definitions/Similarity", @@ -8371,7 +8379,8 @@ "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", "externalDocs": { "url": "https://aka.ms/azure-search-encryption-with-cmk" - } + }, + "x-nullable": true }, "@odata.etag": { "x-ms-client-name": "ETag", diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetServiceStatistics.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetServiceStatistics.json index 13cb75e53894..fbbff6ad079a 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetServiceStatistics.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetServiceStatistics.json @@ -30,10 +30,6 @@ "synonymMaps": { "usage": 2, "quota": 3 - }, - "skillsetCount": { - "usage": 0, - "quota": 3 } }, "limits": { 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 0aa98b1378f8..57a5eedf1b93 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 @@ -5518,12 +5518,14 @@ "k1": { "type": "number", "format": "double", - "description": "This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency." + "description": "This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency.", + "x-nullable": true }, "b": { "type": "number", "format": "double", - "description": "This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document." + "description": "This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document.", + "x-nullable": true } }, "description": "Ranking function based on the Okapi BM25 similarity algorithm. BM25 is a TF-IDF-like algorithm that includes length normalization (controlled by the 'b' parameter) as well as term frequency saturation (controlled by the 'k1' parameter)." @@ -6246,21 +6248,24 @@ "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" }, "$ref": "#/definitions/LexicalAnalyzerName", - "description": "The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields." + "description": "The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.", + "x-nullable": true }, "searchAnalyzer": { "externalDocs": { "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" }, "$ref": "#/definitions/LexicalAnalyzerName", - "description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields." + "description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields.", + "x-nullable": true }, "indexAnalyzer": { "externalDocs": { "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" }, "$ref": "#/definitions/LexicalAnalyzerName", - "description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields." + "description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.", + "x-nullable": true }, "synonymMaps": { "externalDocs": { @@ -6540,7 +6545,8 @@ "text": { "x-ms-client-name": "TextWeights", "$ref": "#/definitions/TextWeights", - "description": "Parameters that boost scoring based on text matches in certain index fields." + "description": "Parameters that boost scoring based on text matches in certain index fields.", + "x-nullable": true }, "functions": { "type": "array", @@ -6695,7 +6701,8 @@ }, "corsOptions": { "$ref": "#/definitions/CorsOptions", - "description": "Options to control Cross-Origin Resource Sharing (CORS) for the index." + "description": "Options to control Cross-Origin Resource Sharing (CORS) for the index.", + "x-nullable": true }, "suggesters": { "type": "array", @@ -6749,7 +6756,8 @@ "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", "externalDocs": { "url": "https://aka.ms/azure-search-encryption-with-cmk" - } + }, + "x-nullable": true }, "similarity": { "$ref": "#/definitions/Similarity", @@ -8371,7 +8379,8 @@ "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", "externalDocs": { "url": "https://aka.ms/azure-search-encryption-with-cmk" - } + }, + "x-nullable": true }, "@odata.etag": { "x-ms-client-name": "ETag", From 31ba1f3214a549f80565a606ff2fa7d1e9f60a66 Mon Sep 17 00:00:00 2001 From: ravgill Date: Wed, 29 Jul 2020 22:44:01 -0700 Subject: [PATCH 10/29] [CosmosDB] Migration support of existing containers/databases to autoscale (#9258) * initial changes * update 2020-04-01 * update example * add default response * fixing ErrorResponse * updated the DefaultErrorResponse * Revert "updated the DefaultErrorResponse" This reverts commit 78c90b5e6339a8314c37ba22b68177dc205eba45. * Revert "fixing ErrorResponse" This reverts commit cab5d0f5ad437e4b3b69e91b9a0161c145249801. * Revert "add default response" This reverts commit 18d879905657d43103232121c111715cd0c0fb57. Co-authored-by: Meha Kaushik --- .../stable/2020-03-01/cosmos-db.json | 794 +++++++++++++++++- ...DBCassandraKeyspaceMigrateToAutoscale.json | 29 + ...ndraKeyspaceMigrateToManualThroughput.json | 26 + ...mosDBCassandraTableMigrateToAutoscale.json | 30 + ...ssandraTableMigrateToManualThroughput.json | 27 + ...osDBGremlinDatabaseMigrateToAutoscale.json | 29 + ...mlinDatabaseMigrateToManualThroughput.json | 26 + ...osmosDBGremlinGraphMigrateToAutoscale.json | 30 + ...GremlinGraphMigrateToManualThroughput.json | 27 + ...DBMongoDBCollectionMigrateToAutoscale.json | 30 + ...DBCollectionMigrateToManualThroughput.json | 27 + ...osDBMongoDBDatabaseMigrateToAutoscale.json | 29 + ...goDBDatabaseMigrateToManualThroughput.json | 26 + ...osmosDBSqlContainerMigrateToAutoscale.json | 30 + ...SqlContainerMigrateToManualThroughput.json | 27 + ...CosmosDBSqlDatabaseMigrateToAutoscale.json | 29 + ...BSqlDatabaseMigrateToManualThroughput.json | 26 + .../CosmosDBTableMigrateToAutoscale.json | 29 + ...osmosDBTableMigrateToManualThroughput.json | 26 + .../stable/2020-04-01/cosmos-db.json | 794 +++++++++++++++++- ...DBCassandraKeyspaceMigrateToAutoscale.json | 29 + ...ndraKeyspaceMigrateToManualThroughput.json | 26 + ...mosDBCassandraTableMigrateToAutoscale.json | 30 + ...ssandraTableMigrateToManualThroughput.json | 27 + ...osDBGremlinDatabaseMigrateToAutoscale.json | 29 + ...mlinDatabaseMigrateToManualThroughput.json | 26 + ...osmosDBGremlinGraphMigrateToAutoscale.json | 30 + ...GremlinGraphMigrateToManualThroughput.json | 27 + ...DBMongoDBCollectionMigrateToAutoscale.json | 30 + ...DBCollectionMigrateToManualThroughput.json | 27 + ...osDBMongoDBDatabaseMigrateToAutoscale.json | 29 + ...goDBDatabaseMigrateToManualThroughput.json | 26 + ...osmosDBSqlContainerMigrateToAutoscale.json | 30 + ...SqlContainerMigrateToManualThroughput.json | 27 + ...CosmosDBSqlDatabaseMigrateToAutoscale.json | 29 + ...BSqlDatabaseMigrateToManualThroughput.json | 26 + .../CosmosDBTableMigrateToAutoscale.json | 29 + ...osmosDBTableMigrateToManualThroughput.json | 26 + 38 files changed, 2544 insertions(+), 50 deletions(-) create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBCassandraTableMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBCassandraTableMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBGremlinGraphMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBGremlinGraphMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBSqlContainerMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBSqlContainerMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBSqlDatabaseMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBTableMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBTableMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBCassandraTableMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBCassandraTableMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBGremlinGraphMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBGremlinGraphMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBSqlContainerMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBSqlContainerMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBSqlDatabaseMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBTableMigrateToAutoscale.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBTableMigrateToManualThroughput.json diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/cosmos-db.json index e648003dc480..8e42d573e5d8 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/cosmos-db.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/cosmos-db.json @@ -1680,6 +1680,86 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "SqlResources_MigrateSqlDatabaseToAutoscale", + "x-ms-examples": { + "CosmosDBSqlDatabaseMigrateToAutoscale": { + "$ref": "./examples/CosmosDBSqlDatabaseMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale", + "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/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL database migrate operation will complete asynchronously." + }, + "200": { + "description": "The SQL database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "SqlResources_MigrateSqlDatabaseToManualThroughput", + "x-ms-examples": { + "CosmosDBSqlDatabaseMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput", + "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/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL database migrate operation will complete asynchronously." + }, + "200": { + "description": "The SQL database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers": { "get": { "operationId": "SqlResources_ListSqlContainers", @@ -1935,6 +2015,92 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "SqlResources_MigrateSqlContainerToAutoscale", + "x-ms-examples": { + "CosmosDBSqlContainerMigrateToAutoscale": { + "$ref": "./examples/CosmosDBSqlContainerMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale", + "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/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL container migrate operation will complete asynchronously." + }, + "200": { + "description": "The SQL container migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "SqlResources_MigrateSqlContainerToManualThroughput", + "x-ms-examples": { + "CosmosDBSqlContainerMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBSqlContainerMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput", + "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/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL container migrate operation will complete asynchronously." + }, + "200": { + "description": "The SQL container migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures": { "get": { "operationId": "SqlResources_ListSqlStoredProcedures", @@ -2706,6 +2872,86 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "MongoDBResources_MigrateMongoDBDatabaseToAutoscale", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseMigrateToAutoscale": { + "$ref": "./examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale", + "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/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB database migrate operation will complete asynchronously." + }, + "200": { + "description": "The MongoDB database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "MongoDBResources_MigrateMongoDBDatabaseToManualThroughput", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput", + "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/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB database migrate operation will complete asynchronously." + }, + "200": { + "description": "The MongoDB database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections": { "get": { "operationId": "MongoDBResources_ListMongoDBCollections", @@ -2961,15 +3207,16 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables": { - "get": { - "operationId": "TableResources_ListTables", + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "MongoDBResources_MigrateMongoDBCollectionToAutoscale", "x-ms-examples": { - "CosmosDBTableList": { - "$ref": "./examples/CosmosDBTableList.json" + "CosmosDBMongoDBCollectionMigrateToAutoscale": { + "$ref": "./examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json" } }, - "description": "Lists the Tables under an existing Azure Cosmos DB database account.", + "description": "Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale", + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" @@ -2980,32 +3227,39 @@ { "$ref": "#/parameters/accountNameParameter" }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { + "202": { + "description": "The MongoDB collection migrate operation will complete asynchronously." + }, "200": { - "description": "The Table properties were retrieved successfully.", + "description": "The MongoDB collection migrate operation was completed successfully.", "schema": { - "$ref": "#/definitions/TableListResult" + "$ref": "#/definitions/ThroughputSettingsGetResults" } } - }, - "x-ms-pageable": { - "nextLinkName": null } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}": { - "get": { - "operationId": "TableResources_GetTable", + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "MongoDBResources_MigrateMongoDBCollectionToManualThroughput", "x-ms-examples": { - "CosmosDBTableGet": { - "$ref": "./examples/CosmosDBTableGet.json" + "CosmosDBMongoDBCollectionMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json" } }, - "description": "Gets the Tables under an existing Azure Cosmos DB database account with the provided name.", + "description": "Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput", + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" @@ -3017,26 +3271,104 @@ "$ref": "#/parameters/accountNameParameter" }, { - "$ref": "#/parameters/tableNameParameter" + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { + "202": { + "description": "The MongoDB collection migrate operation will complete asynchronously." + }, "200": { - "description": "The Table property was retrieved successfully.", + "description": "The MongoDB collection migrate operation was completed successfully.", "schema": { - "$ref": "#/definitions/TableGetResults" + "$ref": "#/definitions/ThroughputSettingsGetResults" } } } - }, - "put": { - "operationId": "TableResources_CreateUpdateTable", + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables": { + "get": { + "operationId": "TableResources_ListTables", "x-ms-examples": { - "CosmosDBTableReplace": { - "$ref": "./examples/CosmosDBTableCreateUpdate.json" + "CosmosDBTableList": { + "$ref": "./examples/CosmosDBTableList.json" + } + }, + "description": "Lists the Tables under an existing Azure Cosmos DB database 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 Table properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/TableListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}": { + "get": { + "operationId": "TableResources_GetTable", + "x-ms-examples": { + "CosmosDBTableGet": { + "$ref": "./examples/CosmosDBTableGet.json" + } + }, + "description": "Gets the Tables under an existing Azure Cosmos DB database account with the provided name.", + "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/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Table property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/TableGetResults" + } + } + } + }, + "put": { + "operationId": "TableResources_CreateUpdateTable", + "x-ms-examples": { + "CosmosDBTableReplace": { + "$ref": "./examples/CosmosDBTableCreateUpdate.json" } }, "description": "Create or update an Azure Cosmos DB Table", @@ -3198,6 +3530,86 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "TableResources_MigrateTableToAutoscale", + "x-ms-examples": { + "CosmosDBTableMigrateToAutoscale": { + "$ref": "./examples/CosmosDBTableMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Table from manual throughput to autoscale", + "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/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Table migrate operation will complete asynchronously." + }, + "200": { + "description": "The Table migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "TableResources_MigrateTableToManualThroughput", + "x-ms-examples": { + "CosmosDBTableMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBTableMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Table from autoscale to manual throughput", + "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/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Table migrate operation will complete asynchronously." + }, + "200": { + "description": "The Table migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces": { "get": { "operationId": "CassandraResources_ListCassandraKeyspaces", @@ -3435,6 +3847,86 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "CassandraResources_MigrateCassandraKeyspaceToAutoscale", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceMigrateToAutoscale": { + "$ref": "./examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale", + "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/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra Keyspace migrate operation will complete asynchronously." + }, + "200": { + "description": "The Cassandra Keyspace migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "CassandraResources_MigrateCassandraKeyspaceToManualThroughput", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput", + "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/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra Keyspace migrate operation will complete asynchronously." + }, + "200": { + "description": "The Cassandra Keyspace migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables": { "get": { "operationId": "CassandraResources_ListCassandraTables", @@ -3690,6 +4182,92 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "CassandraResources_MigrateCassandraTableToAutoscale", + "x-ms-examples": { + "CosmosDBCassandraTableMigrateToAutoscale": { + "$ref": "./examples/CosmosDBCassandraTableMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale", + "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/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra table migrate operation will complete asynchronously." + }, + "200": { + "description": "The Cassandra table migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "CassandraResources_MigrateCassandraTableToManualThroughput", + "x-ms-examples": { + "CosmosDBCassandraTableMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBCassandraTableMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput", + "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/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra table migrate operation will complete asynchronously." + }, + "200": { + "description": "The Cassandra table migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases": { "get": { "operationId": "GremlinResources_ListGremlinDatabases", @@ -3927,6 +4505,86 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "GremlinResources_MigrateGremlinDatabaseToAutoscale", + "x-ms-examples": { + "CosmosDBGremlinDatabaseMigrateToAutoscale": { + "$ref": "./examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale", + "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/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin database migrate operation will complete asynchronously." + }, + "200": { + "description": "The Gremlin database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "GremlinResources_MigrateGremlinDatabaseToManualThroughput", + "x-ms-examples": { + "CosmosDBGremlinDatabaseMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput", + "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/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin database migrate operation will complete asynchronously." + }, + "200": { + "description": "The Gremlin database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs": { "get": { "operationId": "GremlinResources_ListGremlinGraphs", @@ -4181,6 +4839,92 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "GremlinResources_MigrateGremlinGraphToAutoscale", + "x-ms-examples": { + "CosmosDBGremlinGraphMigrateToAutoscale": { + "$ref": "./examples/CosmosDBGremlinGraphMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale", + "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/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin graph migrate operation will complete asynchronously." + }, + "200": { + "description": "The Gremlin graph migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "GremlinResources_MigrateGremlinGraphToManualThroughput", + "x-ms-examples": { + "CosmosDBGremlinGraphMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBGremlinGraphMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput", + "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/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin graph migrate operation will complete asynchronously." + }, + "200": { + "description": "The Gremlin graph migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } } }, "definitions": { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json new file mode 100644 index 000000000000..866e06dd99c2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "provisionedThroughputSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json new file mode 100644 index 000000000000..ddd5b858f647 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBCassandraTableMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBCassandraTableMigrateToAutoscale.json new file mode 100644 index 000000000000..8f57f7e942ac --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBCassandraTableMigrateToAutoscale.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "provisionedThroughputSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBCassandraTableMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBCassandraTableMigrateToManualThroughput.json new file mode 100644 index 000000000000..f901199a4d11 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBCassandraTableMigrateToManualThroughput.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json new file mode 100644 index 000000000000..c8fada5aa737 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "provisionedThroughputSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json new file mode 100644 index 000000000000..9daa31f2fa84 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBGremlinGraphMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBGremlinGraphMigrateToAutoscale.json new file mode 100644 index 000000000000..0c9f21ef808a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBGremlinGraphMigrateToAutoscale.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "provisionedThroughputSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBGremlinGraphMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBGremlinGraphMigrateToManualThroughput.json new file mode 100644 index 000000000000..7ebda5fed28d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBGremlinGraphMigrateToManualThroughput.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json new file mode 100644 index 000000000000..61cce1fbda6f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "provisionedThroughputSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json new file mode 100644 index 000000000000..ea8fd74be2f5 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json new file mode 100644 index 000000000000..c8fada5aa737 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "provisionedThroughputSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json new file mode 100644 index 000000000000..9daa31f2fa84 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBSqlContainerMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBSqlContainerMigrateToAutoscale.json new file mode 100644 index 000000000000..847f6a543506 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBSqlContainerMigrateToAutoscale.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "provisionedThroughputSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBSqlContainerMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBSqlContainerMigrateToManualThroughput.json new file mode 100644 index 000000000000..51092efb4b2f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBSqlContainerMigrateToManualThroughput.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBSqlDatabaseMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBSqlDatabaseMigrateToAutoscale.json new file mode 100644 index 000000000000..c8fada5aa737 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBSqlDatabaseMigrateToAutoscale.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "provisionedThroughputSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json new file mode 100644 index 000000000000..9daa31f2fa84 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBTableMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBTableMigrateToAutoscale.json new file mode 100644 index 000000000000..ac94982bfade --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBTableMigrateToAutoscale.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "provisionedThroughputSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBTableMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBTableMigrateToManualThroughput.json new file mode 100644 index 000000000000..8fd6d3a8313f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBTableMigrateToManualThroughput.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-03-01", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json index 6e73ccd40325..d42b4c445ae0 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json @@ -1680,6 +1680,86 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "SqlResources_MigrateSqlDatabaseToAutoscale", + "x-ms-examples": { + "CosmosDBSqlDatabaseMigrateToAutoscale": { + "$ref": "./examples/CosmosDBSqlDatabaseMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB SQL database from manual throughput to autoscale", + "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/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL database migrate operation will complete asynchronously." + }, + "200": { + "description": "The SQL database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "SqlResources_MigrateSqlDatabaseToManualThroughput", + "x-ms-examples": { + "CosmosDBSqlDatabaseMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB SQL database from autoscale to manual throughput", + "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/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL database migrate operation will complete asynchronously." + }, + "200": { + "description": "The SQL database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers": { "get": { "operationId": "SqlResources_ListSqlContainers", @@ -1935,6 +2015,92 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "SqlResources_MigrateSqlContainerToAutoscale", + "x-ms-examples": { + "CosmosDBSqlContainerMigrateToAutoscale": { + "$ref": "./examples/CosmosDBSqlContainerMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB SQL container from manual throughput to autoscale", + "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/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL container migrate operation will complete asynchronously." + }, + "200": { + "description": "The SQL container migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "SqlResources_MigrateSqlContainerToManualThroughput", + "x-ms-examples": { + "CosmosDBSqlContainerMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBSqlContainerMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB SQL container from autoscale to manual throughput", + "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/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL container migrate operation will complete asynchronously." + }, + "200": { + "description": "The SQL container migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures": { "get": { "operationId": "SqlResources_ListSqlStoredProcedures", @@ -2706,6 +2872,86 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "MongoDBResources_MigrateMongoDBDatabaseToAutoscale", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseMigrateToAutoscale": { + "$ref": "./examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB MongoDB database from manual throughput to autoscale", + "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/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB database migrate operation will complete asynchronously." + }, + "200": { + "description": "The MongoDB database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "MongoDBResources_MigrateMongoDBDatabaseToManualThroughput", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB MongoDB database from autoscale to manual throughput", + "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/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB database migrate operation will complete asynchronously." + }, + "200": { + "description": "The MongoDB database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections": { "get": { "operationId": "MongoDBResources_ListMongoDBCollections", @@ -2961,15 +3207,16 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables": { - "get": { - "operationId": "TableResources_ListTables", + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "MongoDBResources_MigrateMongoDBCollectionToAutoscale", "x-ms-examples": { - "CosmosDBTableList": { - "$ref": "./examples/CosmosDBTableList.json" + "CosmosDBMongoDBCollectionMigrateToAutoscale": { + "$ref": "./examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json" } }, - "description": "Lists the Tables under an existing Azure Cosmos DB database account.", + "description": "Migrate an Azure Cosmos DB MongoDB collection from manual throughput to autoscale", + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" @@ -2980,32 +3227,39 @@ { "$ref": "#/parameters/accountNameParameter" }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { + "202": { + "description": "The MongoDB collection migrate operation will complete asynchronously." + }, "200": { - "description": "The Table properties were retrieved successfully.", + "description": "The MongoDB collection migrate operation was completed successfully.", "schema": { - "$ref": "#/definitions/TableListResult" + "$ref": "#/definitions/ThroughputSettingsGetResults" } } - }, - "x-ms-pageable": { - "nextLinkName": null } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}": { - "get": { - "operationId": "TableResources_GetTable", + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "MongoDBResources_MigrateMongoDBCollectionToManualThroughput", "x-ms-examples": { - "CosmosDBTableGet": { - "$ref": "./examples/CosmosDBTableGet.json" + "CosmosDBMongoDBCollectionMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json" } }, - "description": "Gets the Tables under an existing Azure Cosmos DB database account with the provided name.", + "description": "Migrate an Azure Cosmos DB MongoDB collection from autoscale to manual throughput", + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" @@ -3017,26 +3271,104 @@ "$ref": "#/parameters/accountNameParameter" }, { - "$ref": "#/parameters/tableNameParameter" + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { + "202": { + "description": "The MongoDB collection migrate operation will complete asynchronously." + }, "200": { - "description": "The Table property was retrieved successfully.", + "description": "The MongoDB collection migrate operation was completed successfully.", "schema": { - "$ref": "#/definitions/TableGetResults" + "$ref": "#/definitions/ThroughputSettingsGetResults" } } } - }, - "put": { - "operationId": "TableResources_CreateUpdateTable", + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables": { + "get": { + "operationId": "TableResources_ListTables", "x-ms-examples": { - "CosmosDBTableReplace": { - "$ref": "./examples/CosmosDBTableCreateUpdate.json" + "CosmosDBTableList": { + "$ref": "./examples/CosmosDBTableList.json" + } + }, + "description": "Lists the Tables under an existing Azure Cosmos DB database 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 Table properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/TableListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}": { + "get": { + "operationId": "TableResources_GetTable", + "x-ms-examples": { + "CosmosDBTableGet": { + "$ref": "./examples/CosmosDBTableGet.json" + } + }, + "description": "Gets the Tables under an existing Azure Cosmos DB database account with the provided name.", + "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/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Table property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/TableGetResults" + } + } + } + }, + "put": { + "operationId": "TableResources_CreateUpdateTable", + "x-ms-examples": { + "CosmosDBTableReplace": { + "$ref": "./examples/CosmosDBTableCreateUpdate.json" } }, "description": "Create or update an Azure Cosmos DB Table", @@ -3198,6 +3530,86 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "TableResources_MigrateTableToAutoscale", + "x-ms-examples": { + "CosmosDBTableMigrateToAutoscale": { + "$ref": "./examples/CosmosDBTableMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Table from manual throughput to autoscale", + "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/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Table migrate operation will complete asynchronously." + }, + "200": { + "description": "The Table migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "TableResources_MigrateTableToManualThroughput", + "x-ms-examples": { + "CosmosDBTableMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBTableMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Table from autoscale to manual throughput", + "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/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Table migrate operation will complete asynchronously." + }, + "200": { + "description": "The Table migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces": { "get": { "operationId": "CassandraResources_ListCassandraKeyspaces", @@ -3435,6 +3847,86 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "CassandraResources_MigrateCassandraKeyspaceToAutoscale", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceMigrateToAutoscale": { + "$ref": "./examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra Keyspace from manual throughput to autoscale", + "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/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra Keyspace migrate operation will complete asynchronously." + }, + "200": { + "description": "The Cassandra Keyspace migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "CassandraResources_MigrateCassandraKeyspaceToManualThroughput", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra Keyspace from autoscale to manual throughput", + "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/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra Keyspace migrate operation will complete asynchronously." + }, + "200": { + "description": "The Cassandra Keyspace migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables": { "get": { "operationId": "CassandraResources_ListCassandraTables", @@ -3690,6 +4182,92 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "CassandraResources_MigrateCassandraTableToAutoscale", + "x-ms-examples": { + "CosmosDBCassandraTableMigrateToAutoscale": { + "$ref": "./examples/CosmosDBCassandraTableMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra table from manual throughput to autoscale", + "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/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra table migrate operation will complete asynchronously." + }, + "200": { + "description": "The Cassandra table migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "CassandraResources_MigrateCassandraTableToManualThroughput", + "x-ms-examples": { + "CosmosDBCassandraTableMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBCassandraTableMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Cassandra table from autoscale to manual throughput", + "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/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra table migrate operation will complete asynchronously." + }, + "200": { + "description": "The Cassandra table migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases": { "get": { "operationId": "GremlinResources_ListGremlinDatabases", @@ -3927,6 +4505,86 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "GremlinResources_MigrateGremlinDatabaseToAutoscale", + "x-ms-examples": { + "CosmosDBGremlinDatabaseMigrateToAutoscale": { + "$ref": "./examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Gremlin database from manual throughput to autoscale", + "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/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin database migrate operation will complete asynchronously." + }, + "200": { + "description": "The Gremlin database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "GremlinResources_MigrateGremlinDatabaseToManualThroughput", + "x-ms-examples": { + "CosmosDBGremlinDatabaseMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Gremlin database from autoscale to manual throughput", + "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/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin database migrate operation will complete asynchronously." + }, + "200": { + "description": "The Gremlin database migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs": { "get": { "operationId": "GremlinResources_ListGremlinGraphs", @@ -4181,6 +4839,92 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default/migrateToAutoscale": { + "post": { + "operationId": "GremlinResources_MigrateGremlinGraphToAutoscale", + "x-ms-examples": { + "CosmosDBGremlinGraphMigrateToAutoscale": { + "$ref": "./examples/CosmosDBGremlinGraphMigrateToAutoscale.json" + } + }, + "description": "Migrate an Azure Cosmos DB Gremlin graph from manual throughput to autoscale", + "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/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin graph migrate operation will complete asynchronously." + }, + "200": { + "description": "The Gremlin graph migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default/migrateToManualThroughput": { + "post": { + "operationId": "GremlinResources_MigrateGremlinGraphToManualThroughput", + "x-ms-examples": { + "CosmosDBGremlinGraphMigrateToManualThroughput": { + "$ref": "./examples/CosmosDBGremlinGraphMigrateToManualThroughput.json" + } + }, + "description": "Migrate an Azure Cosmos DB Gremlin graph from autoscale to manual throughput", + "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/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin graph migrate operation will complete asynchronously." + }, + "200": { + "description": "The Gremlin graph migrate operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } } }, "definitions": { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json new file mode 100644 index 000000000000..7014132ba922 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBCassandraKeyspaceMigrateToAutoscale.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json new file mode 100644 index 000000000000..c1d7adb55be3 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBCassandraKeyspaceMigrateToManualThroughput.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBCassandraTableMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBCassandraTableMigrateToAutoscale.json new file mode 100644 index 000000000000..268bb531bda3 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBCassandraTableMigrateToAutoscale.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBCassandraTableMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBCassandraTableMigrateToManualThroughput.json new file mode 100644 index 000000000000..a61aa9159b8f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBCassandraTableMigrateToManualThroughput.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json new file mode 100644 index 000000000000..92b77f53e656 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBGremlinDatabaseMigrateToAutoscale.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json new file mode 100644 index 000000000000..fe3611022024 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBGremlinDatabaseMigrateToManualThroughput.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBGremlinGraphMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBGremlinGraphMigrateToAutoscale.json new file mode 100644 index 000000000000..3548d0c0e8d7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBGremlinGraphMigrateToAutoscale.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBGremlinGraphMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBGremlinGraphMigrateToManualThroughput.json new file mode 100644 index 000000000000..d604a817c552 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBGremlinGraphMigrateToManualThroughput.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json new file mode 100644 index 000000000000..dff0916f8388 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBMongoDBCollectionMigrateToAutoscale.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json new file mode 100644 index 000000000000..a6a1b7fea40d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBMongoDBCollectionMigrateToManualThroughput.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json new file mode 100644 index 000000000000..92b77f53e656 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBMongoDBDatabaseMigrateToAutoscale.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json new file mode 100644 index 000000000000..fe3611022024 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBMongoDBDatabaseMigrateToManualThroughput.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBSqlContainerMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBSqlContainerMigrateToAutoscale.json new file mode 100644 index 000000000000..5d5362d1f905 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBSqlContainerMigrateToAutoscale.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBSqlContainerMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBSqlContainerMigrateToManualThroughput.json new file mode 100644 index 000000000000..014d732eb7e0 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBSqlContainerMigrateToManualThroughput.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBSqlDatabaseMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBSqlDatabaseMigrateToAutoscale.json new file mode 100644 index 000000000000..92b77f53e656 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBSqlDatabaseMigrateToAutoscale.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json new file mode 100644 index 000000000000..fe3611022024 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBSqlDatabaseMigrateToManualThroughput.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBTableMigrateToAutoscale.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBTableMigrateToAutoscale.json new file mode 100644 index 000000000000..c8b8a1a9f94a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBTableMigrateToAutoscale.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "autoscaleSettings": { + "maxThroughput": 4000 + }, + "minimumThroughput": "4000", + "offerReplacePending": "false", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBTableMigrateToManualThroughput.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBTableMigrateToManualThroughput.json new file mode 100644 index 000000000000..8d8dd974645f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBTableMigrateToManualThroughput.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-04-01", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} From 9cd5ff7733bcb60516ae18bb8fd7154659f8830d Mon Sep 17 00:00:00 2001 From: VitaliyKurokhtin Date: Wed, 29 Jul 2020 23:04:29 -0700 Subject: [PATCH 11/29] Documentation updated (#10283) --- .../preview/2017-03-01/apimproducts.json | 4 ++-- .../preview/2018-06-01-preview/definitions.json | 4 ++-- .../preview/2019-12-01-preview/definitions.json | 4 ++-- .../stable/2016-07-07/apimanagement.json | 8 ++++---- .../stable/2016-10-10/apimproducts.json | 8 ++++---- .../stable/2017-03-01/apimproducts.json | 4 ++-- .../stable/2018-01-01/apimproducts.json | 4 ++-- .../stable/2019-01-01/definitions.json | 4 ++-- .../stable/2019-12-01/definitions.json | 4 ++-- 9 files changed, 22 insertions(+), 22 deletions(-) diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimproducts.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimproducts.json index c295c362002e..7818c4d06ba6 100644 --- a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimproducts.json +++ b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimproducts.json @@ -861,13 +861,13 @@ "type": "boolean" }, "approvalRequired": { - "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.", + "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.", "type": "boolean" }, "subscriptionsLimit": { "type": "integer", "format": "int32", - "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false." + "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true." }, "state": { "type": "string", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/definitions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/definitions.json index 5a2330092a28..f15c144c4120 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/definitions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/definitions.json @@ -3330,13 +3330,13 @@ "type": "boolean" }, "approvalRequired": { - "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.", + "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.", "type": "boolean" }, "subscriptionsLimit": { "type": "integer", "format": "int32", - "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false." + "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true." }, "state": { "type": "string", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/definitions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/definitions.json index 3ce3a7c7b67b..87b45aa20ad4 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/definitions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/definitions.json @@ -3545,13 +3545,13 @@ "type": "boolean" }, "approvalRequired": { - "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.", + "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.", "type": "boolean" }, "subscriptionsLimit": { "type": "integer", "format": "int32", - "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false." + "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true." }, "state": { "type": "string", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-07-07/apimanagement.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-07-07/apimanagement.json index 95d7789cdb07..801e3c890ddc 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-07-07/apimanagement.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-07-07/apimanagement.json @@ -5344,12 +5344,12 @@ }, "approvalRequired": { "type": "boolean", - "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false." + "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true." }, "subscriptionsLimit": { "type": "integer", "format": "int32", - "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false." + "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true." }, "state": { "type": "string", @@ -5624,12 +5624,12 @@ }, "approvalRequired": { "type": "boolean", - "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false." + "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true." }, "subscriptionsLimit": { "type": "integer", "format": "int32", - "description": "whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false." + "description": "whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true." }, "state": { "type": "string", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimproducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimproducts.json index 24a54f3eba94..f2eade375f3a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimproducts.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimproducts.json @@ -826,12 +826,12 @@ }, "approvalRequired": { "type": "boolean", - "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false." + "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true." }, "subscriptionsLimit": { "type": "integer", "format": "int32", - "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false." + "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true." }, "state": { "type": "string", @@ -876,12 +876,12 @@ }, "approvalRequired": { "type": "boolean", - "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false." + "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true." }, "subscriptionsLimit": { "type": "integer", "format": "int32", - "description": "whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false." + "description": "whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true." }, "state": { "type": "string", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json index 6ce08fc02df5..b5db2b8d860e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproducts.json @@ -1126,13 +1126,13 @@ "type": "boolean" }, "approvalRequired": { - "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.", + "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.", "type": "boolean" }, "subscriptionsLimit": { "type": "integer", "format": "int32", - "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false." + "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true." }, "state": { "type": "string", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimproducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimproducts.json index d2106e08cd2f..e341239d3b07 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimproducts.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimproducts.json @@ -1177,13 +1177,13 @@ "type": "boolean" }, "approvalRequired": { - "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.", + "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.", "type": "boolean" }, "subscriptionsLimit": { "type": "integer", "format": "int32", - "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false." + "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true." }, "state": { "type": "string", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/definitions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/definitions.json index abe436b4031f..79a0c9320a0d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/definitions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-01-01/definitions.json @@ -3485,13 +3485,13 @@ "type": "boolean" }, "approvalRequired": { - "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.", + "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.", "type": "boolean" }, "subscriptionsLimit": { "type": "integer", "format": "int32", - "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false." + "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true." }, "state": { "type": "string", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/definitions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/definitions.json index 76b03b69548c..f4361ca41aab 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/definitions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/definitions.json @@ -3545,13 +3545,13 @@ "type": "boolean" }, "approvalRequired": { - "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.", + "description": "whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true.", "type": "boolean" }, "subscriptionsLimit": { "type": "integer", "format": "int32", - "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false." + "description": "Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true." }, "state": { "type": "string", From 7ad26a4c98817cdf91f8c81cf0944af4a4f03766 Mon Sep 17 00:00:00 2001 From: Lei Ni <7233663+leni-msft@users.noreply.github.com> Date: Thu, 30 Jul 2020 17:28:14 +0800 Subject: [PATCH 12/29] Update readme.md all-api-versions tags (#10296) * Update readme.md all-api-versions tags * Fix readme.md tag for advisor * Fix readme.md tag for apimanagement * Fix readme.md tag for azsadmin/deployment * Rerun multiapi --- .../advisor/resource-manager/readme.md | 10 ++++- .../apimanagement/resource-manager/readme.md | 3 +- .../resource-manager/readme.md | 2 +- .../resource-manager/readme.md | 11 ++--- .../authorization/resource-manager/readme.md | 11 ++--- .../resource-manager/compute/readme.md | 30 +++++++++++++ .../resource-manager/deployment/readme.md | 7 ++- .../resource-manager/readme.md | 3 +- .../azurestackhci/resource-manager/readme.md | 25 +++++++++++ .../billing/resource-manager/readme.md | 1 + .../botservice/resource-manager/readme.md | 1 + .../cloudshell/resource-manager/readme.md | 26 ++++++++++- .../CustomVision/Prediction/readme.md | 1 + .../CustomVision/Training/readme.md | 1 + .../data-plane/TranslatorText/readme.md | 2 +- .../compute/resource-manager/readme.md | 8 ++-- .../resource-manager/readme.md | 1 + .../cosmos-db/resource-manager/readme.md | 4 +- .../databoxedge/resource-manager/readme.md | 1 + .../digitaltwins/data-plane/readme.md | 25 +++++++++++ .../frontdoor/resource-manager/readme.md | 2 +- .../hybridnetwork/resource-manager/readme.md | 30 +++++++++++++ specification/iotcentral/data-plane/readme.md | 4 +- .../iothub/resource-manager/readme.md | 1 + specification/keyvault/data-plane/readme.md | 6 +++ .../resource-manager/readme.md | 1 + .../maintenance/resource-manager/readme.md | 1 + .../mariadb/resource-manager/readme.md | 2 +- .../mediaservices/data-plane/readme.md | 26 ++++++++++- .../mediaservices/resource-manager/readme.md | 8 ++++ .../monitor/resource-manager/readme.md | 3 +- .../network/resource-manager/readme.md | 44 +++++++++++++++++++ .../postgresql/resource-manager/readme.md | 2 +- .../resources/resource-manager/readme.md | 3 +- .../search/data-plane/Azure.Search/readme.md | 6 ++- .../servicefabric/resource-manager/readme.md | 4 +- .../signalr/resource-manager/readme.md | 1 + specification/sql/resource-manager/readme.md | 9 +++- specification/synapse/data-plane/readme.md | 7 +-- .../timeseriesinsights/data-plane/readme.md | 1 - specification/web/resource-manager/readme.md | 17 +++++++ 41 files changed, 312 insertions(+), 39 deletions(-) diff --git a/specification/advisor/resource-manager/readme.md b/specification/advisor/resource-manager/readme.md index dc0924b739df..1ac722c6bee0 100644 --- a/specification/advisor/resource-manager/readme.md +++ b/specification/advisor/resource-manager/readme.md @@ -29,6 +29,14 @@ openapi-type: arm tag: package-2020-01 ``` +### Tag: package-2020-07-preview + +These settings apply only when `--tag=package-2020-07-preview` is specified on the command line. + +```yaml $(tag) == 'package-2020-07-preview' +input-file: + - Microsoft.Advisor/preview/2020-07-01-preview/advisor.json +``` ### Tag: package-2020-01 @@ -149,11 +157,11 @@ 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 - - $(this-folder)/Microsoft.Advisor/preview/2020-07-01-preview/advisor.json ``` diff --git a/specification/apimanagement/resource-manager/readme.md b/specification/apimanagement/resource-manager/readme.md index 42e087ac4594..c9c4710e178d 100644 --- a/specification/apimanagement/resource-manager/readme.md +++ b/specification/apimanagement/resource-manager/readme.md @@ -46,6 +46,7 @@ input-file: - Microsoft.ApiManagement/stable/2019-12-01/apimbackends.json - Microsoft.ApiManagement/stable/2019-12-01/apimcaches.json - Microsoft.ApiManagement/stable/2019-12-01/apimcertificates.json + - Microsoft.ApiManagement/stable/2019-12-01/apimcontenttypes.json - Microsoft.ApiManagement/stable/2019-12-01/apimdeployment.json - Microsoft.ApiManagement/stable/2019-12-01/apimdiagnostics.json - Microsoft.ApiManagement/stable/2019-12-01/apimemailtemplates.json @@ -392,6 +393,7 @@ input-file: - $(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 @@ -417,7 +419,6 @@ input-file: - $(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/apimcontenttypes.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 diff --git a/specification/appconfiguration/resource-manager/readme.md b/specification/appconfiguration/resource-manager/readme.md index fcc2df72d21d..1368cb987b57 100644 --- a/specification/appconfiguration/resource-manager/readme.md +++ b/specification/appconfiguration/resource-manager/readme.md @@ -141,10 +141,10 @@ 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 - - $(this-folder)/Microsoft.AppConfiguration/stable/2020-06-01/appconfiguration.json ``` diff --git a/specification/applicationinsights/resource-manager/readme.md b/specification/applicationinsights/resource-manager/readme.md index 7d16ec3970ea..eeeb91d57b0e 100644 --- a/specification/applicationinsights/resource-manager/readme.md +++ b/specification/applicationinsights/resource-manager/readme.md @@ -348,31 +348,32 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: - - $(this-folder)/Microsoft.Insights/preview/2020-02-10-preview/WebTestResults_API.json + - $(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/components_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/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/2018-05-01-preview/components_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 - - $(this-folder)/Microsoft.Insights/preview/2020-03-01-preview/componentLinkedStorageAccounts_API.json - - $(this-folder)/Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json + ``` If there are files that should not be in the `all-api-versions` set, diff --git a/specification/authorization/resource-manager/readme.md b/specification/authorization/resource-manager/readme.md index f87f85d6af53..575b2c656dde 100644 --- a/specification/authorization/resource-manager/readme.md +++ b/specification/authorization/resource-manager/readme.md @@ -254,17 +254,18 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json + - $(this-folder)/Microsoft.Authorization/stable/2015-07-01/authorization-ElevateAccessCalls.json + - $(this-folder)/Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.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/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 ``` diff --git a/specification/azsadmin/resource-manager/compute/readme.md b/specification/azsadmin/resource-manager/compute/readme.md index 2bed47d25cc2..6e2d95dd3738 100644 --- a/specification/azsadmin/resource-manager/compute/readme.md +++ b/specification/azsadmin/resource-manager/compute/readme.md @@ -69,3 +69,33 @@ input-file: - Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json - Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json ``` + +## 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.Admin/preview/2015-12-01-preview/Compute.json + - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json + - $(this-folder)/Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json + - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json + - $(this-folder)/Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json + - $(this-folder)/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.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/azsadmin/resource-manager/deployment/readme.md b/specification/azsadmin/resource-manager/deployment/readme.md index 1f31ebeadde9..3de0982996e6 100644 --- a/specification/azsadmin/resource-manager/deployment/readme.md +++ b/specification/azsadmin/resource-manager/deployment/readme.md @@ -36,7 +36,10 @@ input-file: - Microsoft.Deployment.Admin/preview/2019-01-01/Deployment.json - Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlan.json - Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlanOperation.json + - Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlanOperationAttempt.json - Microsoft.Deployment.Admin/preview/2019-01-01/FileContainer.json + - Microsoft.Deployment.Admin/preview/2019-01-01/Locations.json + - Microsoft.Deployment.Admin/preview/2019-01-01/OperationResults.json - Microsoft.Deployment.Admin/preview/2019-01-01/ProductDeployment.json - Microsoft.Deployment.Admin/preview/2019-01-01/ProductPackage.json - Microsoft.Deployment.Admin/preview/2019-01-01/ProductSecret.json @@ -83,10 +86,12 @@ input-file: - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlanOperationAttempt.json - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/FileContainer.json - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/Locations.json + - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/OperationResults.json - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ProductDeployment.json - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ProductPackage.json - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ProductSecret.json - - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/OperationResults.json + - $(this-folder)/Microsoft.Deployment.Admin/preview/2018-07-01/FileContainer.json + - $(this-folder)/Microsoft.Deployment.Admin/preview/2018-07-01/ProductPackage.json ``` diff --git a/specification/azureactivedirectory/resource-manager/readme.md b/specification/azureactivedirectory/resource-manager/readme.md index 46fe420e432e..a280ce576d65 100644 --- a/specification/azureactivedirectory/resource-manager/readme.md +++ b/specification/azureactivedirectory/resource-manager/readme.md @@ -129,11 +129,10 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: - - $(this-folder)/Microsoft.Aadiam/stable/2017-04-01/azureactivedirectory.json - $(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 ``` diff --git a/specification/azurestackhci/resource-manager/readme.md b/specification/azurestackhci/resource-manager/readme.md index 8f80f0887e92..d30f27d90903 100644 --- a/specification/azurestackhci/resource-manager/readme.md +++ b/specification/azurestackhci/resource-manager/readme.md @@ -88,3 +88,28 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## CSharp See configuration in [readme.csharp.md](./readme.csharp.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/billing/resource-manager/readme.md b/specification/billing/resource-manager/readme.md index d7dd48f19501..f2031f4bbc94 100644 --- a/specification/billing/resource-manager/readme.md +++ b/specification/billing/resource-manager/readme.md @@ -244,6 +244,7 @@ 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 diff --git a/specification/botservice/resource-manager/readme.md b/specification/botservice/resource-manager/readme.md index 16c01f946217..de1dff1bfa0b 100644 --- a/specification/botservice/resource-manager/readme.md +++ b/specification/botservice/resource-manager/readme.md @@ -136,6 +136,7 @@ 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 diff --git a/specification/cloudshell/resource-manager/readme.md b/specification/cloudshell/resource-manager/readme.md index 383773dcd1ce..76ac94994ab1 100644 --- a/specification/cloudshell/resource-manager/readme.md +++ b/specification/cloudshell/resource-manager/readme.md @@ -145,4 +145,28 @@ csharp: client-side-validation: false namespace: Microsoft.CloudShell output-folder: $(csharp-sdks-folder)/CloudShell/management/Microsoft.CloudShell/GeneratedProtocol -``` \ No newline at end of file +``` +## 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/data-plane/CustomVision/Prediction/readme.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md index 1441a4a7fcad..3bfd212871ea 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md @@ -138,6 +138,7 @@ require: $(this-folder)/../../../../../profiles/readme.md input-file: - $(this-folder)/stable/v2.0/Prediction.json - $(this-folder)/stable/v3.0/Prediction.json + - $(this-folder)/stable/v3.1/Prediction.json ``` diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md index c24589d79dc3..4941afe9c847 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md @@ -172,6 +172,7 @@ input-file: - $(this-folder)/stable/v3.1/Training.json - $(this-folder)/stable/v3.2/Training.json - $(this-folder)/stable/v3.3/Training.json + ``` If there are files that should not be in the `all-api-versions` set, diff --git a/specification/cognitiveservices/data-plane/TranslatorText/readme.md b/specification/cognitiveservices/data-plane/TranslatorText/readme.md index f6b28b8d49fe..5a735afe3c26 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/readme.md +++ b/specification/cognitiveservices/data-plane/TranslatorText/readme.md @@ -180,8 +180,8 @@ require: $(this-folder)/../../../../profiles/readme.md # all the input files across all versions input-file: - - $(this-folder)/stable/v3.0/TranslatorText.json - $(this-folder)/preview/v1.0-preview.1/TranslatorBatch.json + - $(this-folder)/stable/v3.0/TranslatorText.json ``` diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index a22faa6abe1f..ffe6a70bb98a 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -817,13 +817,15 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(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-05-01/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/2019-12-01/compute.json - $(this-folder)/Microsoft.Compute/stable/2019-12-01/runCommands.json - - $(this-folder)/Microsoft.Compute/stable/2019-04-01/skus.json - $(this-folder)/Microsoft.Compute/stable/2019-11-01/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/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 diff --git a/specification/containerinstance/resource-manager/readme.md b/specification/containerinstance/resource-manager/readme.md index 14839315995e..0aa15d6d6fee 100644 --- a/specification/containerinstance/resource-manager/readme.md +++ b/specification/containerinstance/resource-manager/readme.md @@ -183,6 +183,7 @@ 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 diff --git a/specification/cosmos-db/resource-manager/readme.md b/specification/cosmos-db/resource-manager/readme.md index 4d1ab2248832..3319ea5bcd1a 100644 --- a/specification/cosmos-db/resource-manager/readme.md +++ b/specification/cosmos-db/resource-manager/readme.md @@ -280,10 +280,10 @@ require: $(this-folder)/../../../profiles/readme.md 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/stable/2020-04-01/cosmos-db.json - - $(this-folder)/Microsoft.DocumentDB/stable/2020-04-01/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 diff --git a/specification/databoxedge/resource-manager/readme.md b/specification/databoxedge/resource-manager/readme.md index beec4161964b..525e9e046a23 100644 --- a/specification/databoxedge/resource-manager/readme.md +++ b/specification/databoxedge/resource-manager/readme.md @@ -208,6 +208,7 @@ input-file: - $(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, diff --git a/specification/digitaltwins/data-plane/readme.md b/specification/digitaltwins/data-plane/readme.md index f39f368708dd..c5a96a455705 100644 --- a/specification/digitaltwins/data-plane/readme.md +++ b/specification/digitaltwins/data-plane/readme.md @@ -77,3 +77,28 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## CSharp See configuration in [readme.csharp.md](./readme.csharp.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/preview/2020-05-31-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 +``` + diff --git a/specification/frontdoor/resource-manager/readme.md b/specification/frontdoor/resource-manager/readme.md index 3e959cde8d90..70eef2f16531 100644 --- a/specification/frontdoor/resource-manager/readme.md +++ b/specification/frontdoor/resource-manager/readme.md @@ -272,9 +272,9 @@ 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-04-01/webapplicationfirewall.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 diff --git a/specification/hybridnetwork/resource-manager/readme.md b/specification/hybridnetwork/resource-manager/readme.md index a05587f655d5..e409f06d6d4a 100644 --- a/specification/hybridnetwork/resource-manager/readme.md +++ b/specification/hybridnetwork/resource-manager/readme.md @@ -80,3 +80,33 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## CSharp See configuration in [readme.csharp.md](./readme.csharp.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/iotcentral/data-plane/readme.md b/specification/iotcentral/data-plane/readme.md index 29406dbbaf09..ad32b23a5c39 100644 --- a/specification/iotcentral/data-plane/readme.md +++ b/specification/iotcentral/data-plane/readme.md @@ -53,10 +53,12 @@ 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/preview/2019-10-28-preview/iotcentral.json - $(this-folder)/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentralapps.json + - $(this-folder)/Microsoft.IoTCentral/preview/2019-10-28-preview/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. diff --git a/specification/iothub/resource-manager/readme.md b/specification/iothub/resource-manager/readme.md index cc0782d00196..f0842a0bf742 100644 --- a/specification/iothub/resource-manager/readme.md +++ b/specification/iothub/resource-manager/readme.md @@ -195,6 +195,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(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 diff --git a/specification/keyvault/data-plane/readme.md b/specification/keyvault/data-plane/readme.md index 3e2dcb6241cd..dba1e62004a9 100644 --- a/specification/keyvault/data-plane/readme.md +++ b/specification/keyvault/data-plane/readme.md @@ -174,6 +174,12 @@ input-file: - $(this-folder)/Microsoft.KeyVault/preview/7.2-preview/secrets.json - $(this-folder)/Microsoft.KeyVault/preview/7.2-preview/storage.json - $(this-folder)/Microsoft.KeyVault/preview/7.2-preview/backuprestore.json + - $(this-folder)/Microsoft.KeyVault/preview/7.2-preview/securitydomain.json + - $(this-folder)/Microsoft.KeyVault/stable/7.1/certificates.json + - $(this-folder)/Microsoft.KeyVault/stable/7.1/common.json + - $(this-folder)/Microsoft.KeyVault/stable/7.1/keys.json + - $(this-folder)/Microsoft.KeyVault/stable/7.1/secrets.json + - $(this-folder)/Microsoft.KeyVault/stable/7.1/storage.json - $(this-folder)/Microsoft.KeyVault/preview/7.1/certificates.json - $(this-folder)/Microsoft.KeyVault/preview/7.1/common.json - $(this-folder)/Microsoft.KeyVault/preview/7.1/keys.json diff --git a/specification/machinelearningservices/resource-manager/readme.md b/specification/machinelearningservices/resource-manager/readme.md index 65bcfcfc1907..966eb3408a19 100644 --- a/specification/machinelearningservices/resource-manager/readme.md +++ b/specification/machinelearningservices/resource-manager/readme.md @@ -370,6 +370,7 @@ 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 diff --git a/specification/maintenance/resource-manager/readme.md b/specification/maintenance/resource-manager/readme.md index 4580015e6406..611010338510 100644 --- a/specification/maintenance/resource-manager/readme.md +++ b/specification/maintenance/resource-manager/readme.md @@ -138,6 +138,7 @@ 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 diff --git a/specification/mariadb/resource-manager/readme.md b/specification/mariadb/resource-manager/readme.md index bc1c5568efd2..e6640f77af11 100644 --- a/specification/mariadb/resource-manager/readme.md +++ b/specification/mariadb/resource-manager/readme.md @@ -181,11 +181,11 @@ require: $(this-folder)/../../../profiles/readme.md 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/ServerSecurityAlertPolicies.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 diff --git a/specification/mediaservices/data-plane/readme.md b/specification/mediaservices/data-plane/readme.md index a43ff67118e7..20ae5783b3b2 100644 --- a/specification/mediaservices/data-plane/readme.md +++ b/specification/mediaservices/data-plane/readme.md @@ -70,4 +70,28 @@ csharp: use-internal-constructors: true override-client-name: LiveVideoAnalyticsEdgeClient use-datetimeoffset: true -``` \ No newline at end of file +``` +## 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 +``` + diff --git a/specification/mediaservices/resource-manager/readme.md b/specification/mediaservices/resource-manager/readme.md index 86bd41461ddd..5d98b8ef86d9 100644 --- a/specification/mediaservices/resource-manager/readme.md +++ b/specification/mediaservices/resource-manager/readme.md @@ -338,6 +338,14 @@ 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 diff --git a/specification/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index 403dc210f423..bb42b67ff66b 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -620,6 +620,8 @@ 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 @@ -643,7 +645,6 @@ input-file: - $(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/preview/2020-01-01-preview/managementGroupDiagnosticSettings_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 diff --git a/specification/network/resource-manager/readme.md b/specification/network/resource-manager/readme.md index 8de4b3291bc9..a0022d167160 100644 --- a/specification/network/resource-manager/readme.md +++ b/specification/network/resource-manager/readme.md @@ -1625,6 +1625,50 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(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 diff --git a/specification/postgresql/resource-manager/readme.md b/specification/postgresql/resource-manager/readme.md index f66689491fc6..103327a277e4 100644 --- a/specification/postgresql/resource-manager/readme.md +++ b/specification/postgresql/resource-manager/readme.md @@ -194,13 +194,13 @@ require: $(this-folder)/../../../profiles/readme.md input-file: - $(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/stable/2020-01-01/ServerSecurityAlertPolicies.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/stable/2017-12-01/ServerSecurityAlertPolicies.json - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json ``` diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index 90a7ddc9e204..15f735c4451b 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -678,9 +678,9 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions 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/preview/2019-06-01-preview/templateSpecs.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 @@ -702,6 +702,7 @@ input-file: - $(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 diff --git a/specification/search/data-plane/Azure.Search/readme.md b/specification/search/data-plane/Azure.Search/readme.md index 82139a0477fb..9e0c7d0e0ffa 100644 --- a/specification/search/data-plane/Azure.Search/readme.md +++ b/specification/search/data-plane/Azure.Search/readme.md @@ -162,7 +162,7 @@ directive: - RequiredReadOnlyProperties - where: - $.definitions.SuggestResult.properties["@search.text"] - suppress: + suppress: - RequiredReadOnlyProperties ``` @@ -723,6 +723,10 @@ input-file: - $(this-folder)/preview/2020-06-30-Preview/searchindex.json - $(this-folder)/preview/2020-06-30/searchservice.json - $(this-folder)/preview/2020-06-30/searchindex.json + - $(this-folder)/preview/2019-05-06-preview/searchservice.json + - $(this-folder)/preview/2019-05-06-preview/searchindex.json + - $(this-folder)/stable/2019-05-06/searchservice.json + - $(this-folder)/stable/2019-05-06/searchindex.json ``` diff --git a/specification/servicefabric/resource-manager/readme.md b/specification/servicefabric/resource-manager/readme.md index f9f151dcd57c..49b1b2250bdd 100644 --- a/specification/servicefabric/resource-manager/readme.md +++ b/specification/servicefabric/resource-manager/readme.md @@ -219,6 +219,8 @@ require: $(this-folder)/../../../profiles/readme.md 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 @@ -231,8 +233,6 @@ input-file: - $(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 - - $(this-folder)/Microsoft.ServiceFabric/preview/2020-01-01-preview/managedcluster.json - - $(this-folder)/Microsoft.ServiceFabric/preview/2020-01-01-preview/nodetype.json ``` diff --git a/specification/signalr/resource-manager/readme.md b/specification/signalr/resource-manager/readme.md index 2f52d708922d..bfcc6c5aae19 100644 --- a/specification/signalr/resource-manager/readme.md +++ b/specification/signalr/resource-manager/readme.md @@ -149,6 +149,7 @@ 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 diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index 35842908fc1d..52f33c520137 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -896,11 +896,11 @@ input-file: - $(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/managedDatabases.json - - $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/ServerAzureADAdministrators.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/managedDatabases.json - $(this-folder)/Microsoft.Sql/preview/2020-02-02-preview/ServerAzureADOnlyAuthentications.json - $(this-folder)/Microsoft.Sql/stable/2014-04-01/capabilities.json @@ -920,6 +920,10 @@ input-file: - $(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/2019-06-01-preview/databases.json - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.json @@ -931,6 +935,7 @@ input-file: - $(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 diff --git a/specification/synapse/data-plane/readme.md b/specification/synapse/data-plane/readme.md index bbc3bb50a0ed..05a24f9f989c 100644 --- a/specification/synapse/data-plane/readme.md +++ b/specification/synapse/data-plane/readme.md @@ -161,12 +161,13 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: - - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json - - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/managedPrivateEndpoints.json - $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json - - $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/monitoring.json + - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json - $(this-folder)/Microsoft.Synapse/preview/2020-02-01-preview/roles.json - $(this-folder)/Microsoft.Synapse/preview/2020-02-01-preview/roleAssignments.json + - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/managedPrivateEndpoints.json + - $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/monitoring.json + ``` If there are files that should not be in the `all-api-versions` set, diff --git a/specification/timeseriesinsights/data-plane/readme.md b/specification/timeseriesinsights/data-plane/readme.md index a1b84838b2b2..86b95fdaf588 100644 --- a/specification/timeseriesinsights/data-plane/readme.md +++ b/specification/timeseriesinsights/data-plane/readme.md @@ -84,7 +84,6 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: - $(this-folder)/Microsoft.TimeSeriesInsights/stable/2020-07-31/timeseriesinsights.json - - $(this-folder)/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json ``` diff --git a/specification/web/resource-manager/readme.md b/specification/web/resource-manager/readme.md index 758b1ed4df06..721c9c5bd742 100644 --- a/specification/web/resource-manager/readme.md +++ b/specification/web/resource-manager/readme.md @@ -1229,6 +1229,23 @@ 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 From f7665e505eabb78bf50c80c02cf26188a2594dc4 Mon Sep 17 00:00:00 2001 From: vnvaditya Date: Thu, 30 Jul 2020 03:36:48 -0700 Subject: [PATCH 13/29] [datashare] sort api's and definitions (#10273) * Sort API's andn defintions * Sort API's andn defintions * Sort API's and defintions Co-authored-by: Aditya Vutukuri --- .../stable/2019-11-01/DataShare.json | 1494 ++++++++--------- 1 file changed, 747 insertions(+), 747 deletions(-) diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json index 734372e92f71..734c0df12808 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/DataShare.json @@ -16,6 +16,53 @@ "application/json" ], "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DataShare/accounts": { + "get": { + "tags": [ + "Account" + ], + "summary": "List Accounts in a subscription", + "description": "List Accounts in Subscription", + "operationId": "Accounts_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$skipToken", + "in": "query", + "description": "Continuation token", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "An error response received from the Microsoft.DataShare resource provider.", + "schema": { + "$ref": "#/definitions/DataShareError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Accounts_ListBySubscription": { + "$ref": "./examples/Accounts_ListBySubscription.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}": { "get": { "tags": [ @@ -214,53 +261,6 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DataShare/accounts": { - "get": { - "tags": [ - "Account" - ], - "summary": "List Accounts in a subscription", - "description": "List Accounts in Subscription", - "operationId": "Accounts_ListBySubscription", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "$skipToken", - "in": "query", - "description": "Continuation token", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AccountList" - } - }, - "default": { - "description": "An error response received from the Microsoft.DataShare resource provider.", - "schema": { - "$ref": "#/definitions/DataShareError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Accounts_ListBySubscription": { - "$ref": "./examples/Accounts_ListBySubscription.json" - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts": { "get": { "tags": [ @@ -311,40 +311,31 @@ } } }, - "/providers/Microsoft.DataShare/locations/{location}/RejectInvitation": { - "post": { + "/providers/Microsoft.DataShare/ListInvitations": { + "get": { "tags": [ "ConsumerInvitation" ], - "summary": "Rejects the invitation identified by invitationId", - "description": "Reject an invitation", - "operationId": "ConsumerInvitations_RejectInvitation", + "summary": "List the invitations", + "description": "Lists invitations", + "operationId": "ConsumerInvitations_ListInvitations", "parameters": [ { - "name": "location", - "in": "path", - "description": "Location of the invitation", - "required": true, - "type": "string" - }, - { - "name": "invitation", - "in": "body", - "description": "An invitation payload", - "required": true, - "schema": { - "$ref": "#/definitions/ConsumerInvitation" - } + "$ref": "#/parameters/api-version" }, { - "$ref": "#/parameters/api-version" + "name": "$skipToken", + "in": "query", + "description": "The continuation token", + "required": false, + "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ConsumerInvitation" + "$ref": "#/definitions/ConsumerInvitationList" } }, "default": { @@ -354,9 +345,12 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "ConsumerInvitations_RejectInvitation": { - "$ref": "./examples/ConsumerInvitations_RejectInvitation.json" + "ConsumerInvitations_ListInvitations": { + "$ref": "./examples/ConsumerInvitations_ListInvitations.json" } } } @@ -409,31 +403,40 @@ } } }, - "/providers/Microsoft.DataShare/ListInvitations": { - "get": { + "/providers/Microsoft.DataShare/locations/{location}/RejectInvitation": { + "post": { "tags": [ "ConsumerInvitation" ], - "summary": "List the invitations", - "description": "Lists invitations", - "operationId": "ConsumerInvitations_ListInvitations", + "summary": "Rejects the invitation identified by invitationId", + "description": "Reject an invitation", + "operationId": "ConsumerInvitations_RejectInvitation", "parameters": [ { - "$ref": "#/parameters/api-version" + "name": "location", + "in": "path", + "description": "Location of the invitation", + "required": true, + "type": "string" }, { - "name": "$skipToken", - "in": "query", - "description": "The continuation token", - "required": false, - "type": "string" + "name": "invitation", + "in": "body", + "description": "An invitation payload", + "required": true, + "schema": { + "$ref": "#/definitions/ConsumerInvitation" + } + }, + { + "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ConsumerInvitationList" + "$ref": "#/definitions/ConsumerInvitation" } }, "default": { @@ -443,12 +446,9 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "ConsumerInvitations_ListInvitations": { - "$ref": "./examples/ConsumerInvitations_ListInvitations.json" + "ConsumerInvitations_RejectInvitation": { + "$ref": "./examples/ConsumerInvitations_RejectInvitation.json" } } } @@ -1283,14 +1283,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizationDetails": { + "post": { "tags": [ "Share" ], - "summary": "Get a specified share", - "description": "Get a share ", - "operationId": "Shares_Get", + "summary": "List data set level details for a share synchronization", + "description": "List synchronization details", + "operationId": "Shares_ListSynchronizationDetails", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1304,19 +1304,49 @@ { "name": "shareName", "in": "path", - "description": "The name of the share to retrieve.", + "description": "The name of the share.", "required": true, "type": "string" }, + { + "name": "shareSynchronization", + "in": "body", + "description": "Share Synchronization payload.", + "required": true, + "schema": { + "$ref": "#/definitions/ShareSynchronization" + } + }, { "$ref": "#/parameters/api-version" + }, + { + "name": "$skipToken", + "in": "query", + "description": "Continuation token", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "Filters the results using OData syntax.", + "required": false, + "type": "string" + }, + { + "name": "$orderby", + "in": "query", + "description": "Sorts the results using OData syntax.", + "required": false, + "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/Share" + "$ref": "#/definitions/SynchronizationDetailsList" } }, "default": { @@ -1326,19 +1356,24 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "Shares_Get": { - "$ref": "./examples/Shares_Get.json" + "Shares_ListSynchronizationDetails": { + "$ref": "./examples/Shares_ListSynchronizationDetails.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizations": { + "post": { "tags": [ "Share" ], - "summary": "Create a share in the given account.", - "description": "Create a share ", - "operationId": "Shares_Create", + "summary": "List Synchronizations in a share", + "description": "List synchronizations of a share", + "operationId": "Shares_ListSynchronizations", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1356,126 +1391,13 @@ "required": true, "type": "string" }, - { - "name": "share", - "in": "body", - "description": "The share payload", - "required": true, - "schema": { - "$ref": "#/definitions/Share" - } - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Share" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Share" - } - }, - "default": { - "description": "An error response received from the Microsoft.DataShare resource provider.", - "schema": { - "$ref": "#/definitions/DataShareError" - } - } - }, - "x-ms-examples": { - "Shares_Create": { - "$ref": "./examples/Shares_Create.json" - } - } - }, - "delete": { - "tags": [ - "Share" - ], - "summary": "Deletes a share", - "description": "Delete a share ", - "operationId": "Shares_Delete", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/accountName" - }, - { - "name": "shareName", - "in": "path", - "description": "The name of the share.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OperationResponse" - } - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "Success" - }, - "default": { - "description": "An error response received from the Microsoft.DataShare resource provider.", - "schema": { - "$ref": "#/definitions/DataShareError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Shares_Delete": { - "$ref": "./examples/Shares_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares": { - "get": { - "tags": [ - "Share" - ], - "summary": "List of available shares under an account.", - "description": "List shares in an account", - "operationId": "Shares_ListByAccount", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/accountName" - }, { "$ref": "#/parameters/api-version" }, { "name": "$skipToken", "in": "query", - "description": "Continuation Token", + "description": "Continuation token", "required": false, "type": "string" }, @@ -1498,7 +1420,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ShareList" + "$ref": "#/definitions/ShareSynchronizationList" } }, "default": { @@ -1512,20 +1434,20 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "Shares_ListByAccount": { - "$ref": "./examples/Shares_ListByAccount.json" + "Shares_ListSynchronizations": { + "$ref": "./examples/Shares_ListSynchronizations.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}/reinstate": { "post": { "tags": [ "Share" ], - "summary": "List Synchronizations in a share", - "description": "List synchronizations of a share", - "operationId": "Shares_ListSynchronizations", + "summary": "Reinstate share subscription in a provider share.", + "description": "Reinstate share subscription in a provider share", + "operationId": "ProviderShareSubscriptions_Reinstate", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1544,35 +1466,21 @@ "type": "string" }, { - "$ref": "#/parameters/api-version" - }, - { - "name": "$skipToken", - "in": "query", - "description": "Continuation token", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "Filters the results using OData syntax.", - "required": false, + "name": "providerShareSubscriptionId", + "in": "path", + "description": "To locate shareSubscription", + "required": true, "type": "string" }, { - "name": "$orderby", - "in": "query", - "description": "Sorts the results using OData syntax.", - "required": false, - "type": "string" + "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ShareSynchronizationList" + "$ref": "#/definitions/ProviderShareSubscription" } }, "default": { @@ -1582,24 +1490,21 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "x-ms-examples": { - "Shares_ListSynchronizations": { - "$ref": "./examples/Shares_ListSynchronizations.json" + "ProviderShareSubscriptions_Reinstate": { + "$ref": "./examples/ProviderShareSubscriptions_Reinstate.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizationDetails": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}/revoke": { "post": { "tags": [ "Share" ], - "summary": "List data set level details for a share synchronization", - "description": "List synchronization details", - "operationId": "Shares_ListSynchronizationDetails", + "summary": "Revoke share subscription in a provider share.", + "description": "Revoke share subscription in a provider share", + "operationId": "ProviderShareSubscriptions_Revoke", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1618,44 +1523,27 @@ "type": "string" }, { - "name": "shareSynchronization", - "in": "body", - "description": "Share Synchronization payload.", + "name": "providerShareSubscriptionId", + "in": "path", + "description": "To locate shareSubscription", "required": true, - "schema": { - "$ref": "#/definitions/ShareSynchronization" - } - }, - { - "$ref": "#/parameters/api-version" - }, - { - "name": "$skipToken", - "in": "query", - "description": "Continuation token", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "Filters the results using OData syntax.", - "required": false, "type": "string" }, { - "name": "$orderby", - "in": "query", - "description": "Sorts the results using OData syntax.", - "required": false, - "type": "string" + "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/SynchronizationDetailsList" + "$ref": "#/definitions/ProviderShareSubscription" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/ProviderShareSubscription" } }, "default": { @@ -1665,12 +1553,13 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" }, "x-ms-examples": { - "Shares_ListSynchronizationDetails": { - "$ref": "./examples/Shares_ListSynchronizationDetails.json" + "ProviderShareSubscriptions_Revoke": { + "$ref": "./examples/ProviderShareSubscriptions_Revoke.json" } } } @@ -1792,14 +1681,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}/revoke": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}": { + "get": { "tags": [ "Share" ], - "summary": "Revoke share subscription in a provider share.", - "description": "Revoke share subscription in a provider share", - "operationId": "ProviderShareSubscriptions_Revoke", + "summary": "Get a specified share", + "description": "Get a share ", + "operationId": "Shares_Get", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1813,14 +1702,7 @@ { "name": "shareName", "in": "path", - "description": "The name of the share.", - "required": true, - "type": "string" - }, - { - "name": "providerShareSubscriptionId", - "in": "path", - "description": "To locate shareSubscription", + "description": "The name of the share to retrieve.", "required": true, "type": "string" }, @@ -1832,13 +1714,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ProviderShareSubscription" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/ProviderShareSubscription" + "$ref": "#/definitions/Share" } }, "default": { @@ -1848,25 +1724,19 @@ } } }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, "x-ms-examples": { - "ProviderShareSubscriptions_Revoke": { - "$ref": "./examples/ProviderShareSubscriptions_Revoke.json" + "Shares_Get": { + "$ref": "./examples/Shares_Get.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/providerShareSubscriptions/{providerShareSubscriptionId}/reinstate": { - "post": { + }, + "put": { "tags": [ "Share" ], - "summary": "Reinstate share subscription in a provider share.", - "description": "Reinstate share subscription in a provider share", - "operationId": "ProviderShareSubscriptions_Reinstate", + "summary": "Create a share in the given account.", + "description": "Create a share ", + "operationId": "Shares_Create", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1885,21 +1755,29 @@ "type": "string" }, { - "name": "providerShareSubscriptionId", - "in": "path", - "description": "To locate shareSubscription", + "name": "share", + "in": "body", + "description": "The share payload", "required": true, - "type": "string" + "schema": { + "$ref": "#/definitions/Share" + } }, { "$ref": "#/parameters/api-version" } ], "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Share" + } + }, "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ProviderShareSubscription" + "$ref": "#/definitions/Share" } }, "default": { @@ -1910,20 +1788,18 @@ } }, "x-ms-examples": { - "ProviderShareSubscriptions_Reinstate": { - "$ref": "./examples/ProviderShareSubscriptions_Reinstate.json" + "Shares_Create": { + "$ref": "./examples/Shares_Create.json" } } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}": { - "get": { + }, + "delete": { "tags": [ - "ShareSubscription" + "Share" ], - "summary": "Get shareSubscription in an account.", - "description": "Get a shareSubscription in an account", - "operationId": "ShareSubscriptions_Get", + "summary": "Deletes a share", + "description": "Delete a share ", + "operationId": "Shares_Delete", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1935,9 +1811,9 @@ "$ref": "#/parameters/accountName" }, { - "name": "shareSubscriptionName", + "name": "shareName", "in": "path", - "description": "The name of the shareSubscription.", + "description": "The name of the share.", "required": true, "type": "string" }, @@ -1949,9 +1825,15 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ShareSubscription" + "$ref": "#/definitions/OperationResponse" } }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "Success" + }, "default": { "description": "An error response received from the Microsoft.DataShare resource provider.", "schema": { @@ -1959,19 +1841,22 @@ } } }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "ShareSubscriptions_Get": { - "$ref": "./examples/ShareSubscriptions_Get.json" + "Shares_Delete": { + "$ref": "./examples/Shares_Delete.json" } } - }, - "put": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares": { + "get": { "tags": [ - "ShareSubscription" + "Share" ], - "summary": "Create shareSubscription in an account.", - "description": "Create a shareSubscription in an account", - "operationId": "ShareSubscriptions_Create", + "summary": "List of available shares under an account.", + "description": "List shares in an account", + "operationId": "Shares_ListByAccount", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1983,36 +1868,35 @@ "$ref": "#/parameters/accountName" }, { - "name": "shareSubscriptionName", - "in": "path", - "description": "The name of the shareSubscription.", - "required": true, + "$ref": "#/parameters/api-version" + }, + { + "name": "$skipToken", + "in": "query", + "description": "Continuation Token", + "required": false, "type": "string" }, { - "name": "shareSubscription", - "in": "body", - "description": "create parameters for shareSubscription", - "required": true, - "schema": { - "$ref": "#/definitions/ShareSubscription" - } + "name": "$filter", + "in": "query", + "description": "Filters the results using OData syntax.", + "required": false, + "type": "string" }, { - "$ref": "#/parameters/api-version" + "name": "$orderby", + "in": "query", + "description": "Sorts the results using OData syntax.", + "required": false, + "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ShareSubscription" - } - }, - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ShareSubscription" + "$ref": "#/definitions/ShareList" } }, "default": { @@ -2022,19 +1906,24 @@ } } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "ShareSubscriptions_Create": { - "$ref": "./examples/ShareSubscriptions_Create.json" + "Shares_ListByAccount": { + "$ref": "./examples/Shares_ListByAccount.json" } } - }, - "delete": { + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/cancelSynchronization": { + "post": { "tags": [ "ShareSubscription" ], - "summary": "Delete shareSubscription in an account.", - "description": "Delete a shareSubscription in an account", - "operationId": "ShareSubscriptions_Delete", + "summary": "Request cancellation of a data share snapshot", + "description": "Request to cancel a synchronization.", + "operationId": "ShareSubscriptions_CancelSynchronization", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -2053,85 +1942,29 @@ "type": "string" }, { - "$ref": "#/parameters/api-version" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OperationResponse" - } - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "Success" - }, - "default": { - "description": "An error response received from the Microsoft.DataShare resource provider.", + "name": "shareSubscriptionSynchronization", + "in": "body", + "description": "Share Subscription Synchronization payload.", + "required": true, "schema": { - "$ref": "#/definitions/DataShareError" + "$ref": "#/definitions/ShareSubscriptionSynchronization" } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "ShareSubscriptions_Delete": { - "$ref": "./examples/ShareSubscriptions_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions": { - "get": { - "tags": [ - "ShareSubscription" - ], - "summary": "List of available share subscriptions under an account.", - "description": "List share subscriptions in an account", - "operationId": "ShareSubscriptions_ListByAccount", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/accountName" }, { "$ref": "#/parameters/api-version" - }, - { - "name": "$skipToken", - "in": "query", - "description": "Continuation Token", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "Filters the results using OData syntax.", - "required": false, - "type": "string" - }, - { - "name": "$orderby", - "in": "query", - "description": "Sorts the results using OData syntax.", - "required": false, - "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ShareSubscriptionList" + "$ref": "#/definitions/ShareSubscriptionSynchronization" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/ShareSubscriptionSynchronization" } }, "default": { @@ -2141,12 +1974,13 @@ } } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" }, "x-ms-examples": { - "ShareSubscriptions_ListByAccount": { - "$ref": "./examples/ShareSubscriptions_ListByAccount.json" + "ShareSubscriptions_CancelSynchronization": { + "$ref": "./examples/ShareSubscriptions_CancelSynchronization.json" } } } @@ -2271,14 +2105,14 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizations": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizationDetails": { "post": { "tags": [ "ShareSubscription" ], - "summary": "List Synchronizations in a share subscription.", - "description": "List synchronizations of a share subscription", - "operationId": "ShareSubscriptions_ListSynchronizations", + "summary": "List data set level details for a share subscription synchronization", + "description": "List synchronization details", + "operationId": "ShareSubscriptions_ListSynchronizationDetails", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -2296,6 +2130,15 @@ "required": true, "type": "string" }, + { + "name": "shareSubscriptionSynchronization", + "in": "body", + "description": "Share Subscription Synchronization payload.", + "required": true, + "schema": { + "$ref": "#/definitions/ShareSubscriptionSynchronization" + } + }, { "$ref": "#/parameters/api-version" }, @@ -2325,7 +2168,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ShareSubscriptionSynchronizationList" + "$ref": "#/definitions/SynchronizationDetailsList" } }, "default": { @@ -2339,20 +2182,20 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "ShareSubscriptions_ListSynchronizations": { - "$ref": "./examples/ShareSubscriptions_ListSynchronizations.json" + "ShareSubscriptions_ListSynchronizationDetails": { + "$ref": "./examples/ShareSubscriptions_ListSynchronizationDetails.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizationDetails": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizations": { "post": { "tags": [ "ShareSubscription" ], - "summary": "List data set level details for a share subscription synchronization", - "description": "List synchronization details", - "operationId": "ShareSubscriptions_ListSynchronizationDetails", + "summary": "List Synchronizations in a share subscription.", + "description": "List synchronizations of a share subscription", + "operationId": "ShareSubscriptions_ListSynchronizations", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -2370,15 +2213,6 @@ "required": true, "type": "string" }, - { - "name": "shareSubscriptionSynchronization", - "in": "body", - "description": "Share Subscription Synchronization payload.", - "required": true, - "schema": { - "$ref": "#/definitions/ShareSubscriptionSynchronization" - } - }, { "$ref": "#/parameters/api-version" }, @@ -2408,7 +2242,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/SynchronizationDetailsList" + "$ref": "#/definitions/ShareSubscriptionSynchronizationList" } }, "default": { @@ -2422,8 +2256,8 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "ShareSubscriptions_ListSynchronizationDetails": { - "$ref": "./examples/ShareSubscriptions_ListSynchronizationDetails.json" + "ShareSubscriptions_ListSynchronizations": { + "$ref": "./examples/ShareSubscriptions_ListSynchronizations.json" } } } @@ -2497,15 +2331,15 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/cancelSynchronization": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}": { + "get": { "tags": [ "ShareSubscription" ], - "summary": "Request cancellation of a data share snapshot", - "description": "Request to cancel a synchronization.", - "operationId": "ShareSubscriptions_CancelSynchronization", - "parameters": [ + "summary": "Get shareSubscription in an account.", + "description": "Get a shareSubscription in an account", + "operationId": "ShareSubscriptions_Get", + "parameters": [ { "$ref": "#/parameters/subscriptionId" }, @@ -2523,12 +2357,60 @@ "type": "string" }, { - "name": "shareSubscriptionSynchronization", + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ShareSubscription" + } + }, + "default": { + "description": "An error response received from the Microsoft.DataShare resource provider.", + "schema": { + "$ref": "#/definitions/DataShareError" + } + } + }, + "x-ms-examples": { + "ShareSubscriptions_Get": { + "$ref": "./examples/ShareSubscriptions_Get.json" + } + } + }, + "put": { + "tags": [ + "ShareSubscription" + ], + "summary": "Create shareSubscription in an account.", + "description": "Create a shareSubscription in an account", + "operationId": "ShareSubscriptions_Create", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "name": "shareSubscriptionName", + "in": "path", + "description": "The name of the shareSubscription.", + "required": true, + "type": "string" + }, + { + "name": "shareSubscription", "in": "body", - "description": "Share Subscription Synchronization payload.", + "description": "create parameters for shareSubscription", "required": true, "schema": { - "$ref": "#/definitions/ShareSubscriptionSynchronization" + "$ref": "#/definitions/ShareSubscription" } }, { @@ -2539,15 +2421,69 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ShareSubscriptionSynchronization" + "$ref": "#/definitions/ShareSubscription" } }, - "202": { - "description": "Accepted", + "201": { + "description": "Success", "schema": { - "$ref": "#/definitions/ShareSubscriptionSynchronization" + "$ref": "#/definitions/ShareSubscription" + } + }, + "default": { + "description": "An error response received from the Microsoft.DataShare resource provider.", + "schema": { + "$ref": "#/definitions/DataShareError" + } + } + }, + "x-ms-examples": { + "ShareSubscriptions_Create": { + "$ref": "./examples/ShareSubscriptions_Create.json" + } + } + }, + "delete": { + "tags": [ + "ShareSubscription" + ], + "summary": "Delete shareSubscription in an account.", + "description": "Delete a shareSubscription in an account", + "operationId": "ShareSubscriptions_Delete", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "name": "shareSubscriptionName", + "in": "path", + "description": "The name of the shareSubscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationResponse" } }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "Success" + }, "default": { "description": "An error response received from the Microsoft.DataShare resource provider.", "schema": { @@ -2556,12 +2492,76 @@ } }, "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" + "x-ms-examples": { + "ShareSubscriptions_Delete": { + "$ref": "./examples/ShareSubscriptions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions": { + "get": { + "tags": [ + "ShareSubscription" + ], + "summary": "List of available share subscriptions under an account.", + "description": "List share subscriptions in an account", + "operationId": "ShareSubscriptions_ListByAccount", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "$skipToken", + "in": "query", + "description": "Continuation Token", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "Filters the results using OData syntax.", + "required": false, + "type": "string" + }, + { + "name": "$orderby", + "in": "query", + "description": "Sorts the results using OData syntax.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ShareSubscriptionList" + } + }, + "default": { + "description": "An error response received from the Microsoft.DataShare resource provider.", + "schema": { + "$ref": "#/definitions/DataShareError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" }, "x-ms-examples": { - "ShareSubscriptions_CancelSynchronization": { - "$ref": "./examples/ShareSubscriptions_CancelSynchronization.json" + "ShareSubscriptions_ListByAccount": { + "$ref": "./examples/ShareSubscriptions_ListByAccount.json" } } } @@ -3067,6 +3067,27 @@ } }, "definitions": { + "AccountList": { + "description": "List response for get Accounts.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/Account" + } + } + } + }, "Account": { "description": "An account data transfer object.", "required": [ @@ -3198,19 +3219,6 @@ } } }, - "AccountUpdateParameters": { - "description": "Update parameters for accounts", - "type": "object", - "properties": { - "tags": { - "description": "Tags on the azure resource.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, "OperationResponse": { "description": "Response for long running operation", "required": [ @@ -3250,8 +3258,21 @@ } } }, - "AccountList": { - "description": "List response for get Accounts.", + "AccountUpdateParameters": { + "description": "Update parameters for accounts", + "type": "object", + "properties": { + "tags": { + "description": "Tags on the azure resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ConsumerInvitationList": { + "description": "List response for get InvitationList", "required": [ "value" ], @@ -3266,7 +3287,7 @@ "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/Account" + "$ref": "#/definitions/ConsumerInvitation" } } } @@ -3381,38 +3402,17 @@ } } }, - "ConsumerInvitationList": { - "description": "List response for get InvitationList", + "DataSet": { + "description": "A DataSet data transfer object.", "required": [ - "value" + "kind" ], "type": "object", - "properties": { - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ConsumerInvitation" - } - } - } - }, - "DataSet": { - "description": "A DataSet data transfer object.", - "required": [ - "kind" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyDto" - } - ], + "allOf": [ + { + "$ref": "#/definitions/ProxyDto" + } + ], "properties": { "kind": { "description": "Kind of data set.", @@ -3805,122 +3805,6 @@ } } }, - "Share": { - "description": "A share data transfer object.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ProxyDto" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/ShareProperties", - "description": "Properties on the share", - "x-ms-client-flatten": true - } - } - }, - "ShareProperties": { - "description": "Share property bag.", - "type": "object", - "properties": { - "createdAt": { - "format": "date-time", - "description": "Time at which the share was created.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "Share description.", - "type": "string" - }, - "provisioningState": { - "description": "Gets or sets the provisioning state", - "enum": [ - "Succeeded", - "Creating", - "Deleting", - "Moving", - "Failed" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "provisioningState", - "modelAsString": true - } - }, - "shareKind": { - "description": "Share kind.", - "enum": [ - "CopyBased", - "InPlace" - ], - "type": "string", - "x-ms-enum": { - "name": "shareKind", - "modelAsString": true - } - }, - "terms": { - "description": "Share terms.", - "type": "string" - }, - "userEmail": { - "description": "Email of the user who created the resource", - "type": "string", - "readOnly": true - }, - "userName": { - "description": "Name of the user who created the resource", - "type": "string", - "readOnly": true - } - } - }, - "ShareList": { - "description": "List response for get Shares.", - "required": [ - "value" - ], - "type": "object", - "properties": { - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Share" - } - } - } - }, - "ShareSynchronizationList": { - "description": "List response for get ShareSynchronization.", - "required": [ - "value" - ], - "type": "object", - "properties": { - "nextLink": { - "description": "The Url of next result page.", - "type": "string" - }, - "value": { - "description": "Collection of items of type DataTransferObjects.", - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/ShareSynchronization" - } - } - } - }, "ShareSynchronization": { "description": "A ShareSynchronization data transfer object.", "type": "object", @@ -4109,6 +3993,27 @@ } } }, + "ShareSynchronizationList": { + "description": "List response for get ShareSynchronization.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ShareSynchronization" + } + } + } + }, "ProviderShareSubscription": { "description": "A provider side share subscription data transfer object.", "type": "object", @@ -4209,11 +4114,8 @@ } } }, - "ShareSubscription": { - "description": "A share subscription data transfer object.", - "required": [ - "properties" - ], + "Share": { + "description": "A share data transfer object.", "type": "object", "allOf": [ { @@ -4222,47 +4124,28 @@ ], "properties": { "properties": { - "$ref": "#/definitions/ShareSubscriptionProperties", - "description": "Properties on the share subscription", + "$ref": "#/definitions/ShareProperties", + "description": "Properties on the share", "x-ms-client-flatten": true } } }, - "ShareSubscriptionProperties": { - "description": "Share subscription property bag.", - "required": [ - "invitationId", - "sourceShareLocation" - ], + "ShareProperties": { + "description": "Share property bag.", "type": "object", "properties": { "createdAt": { "format": "date-time", - "description": "Time at which the share subscription was created.", + "description": "Time at which the share was created.", "type": "string", "readOnly": true }, - "invitationId": { - "description": "The invitation id.", + "description": { + "description": "Share description.", "type": "string" }, - "providerEmail": { - "description": "Email of the provider who created the resource", - "type": "string", - "readOnly": true - }, - "providerName": { - "description": "Name of the provider who created the resource", - "type": "string", - "readOnly": true - }, - "providerTenantName": { - "description": "Tenant name of the provider who created the resource", - "type": "string", - "readOnly": true - }, "provisioningState": { - "description": "Provisioning state of the share subscription", + "description": "Gets or sets the provisioning state", "enum": [ "Succeeded", "Creating", @@ -4277,51 +4160,20 @@ "modelAsString": true } }, - "shareDescription": { - "description": "Description of share", - "type": "string", - "readOnly": true - }, "shareKind": { - "description": "Kind of share", + "description": "Share kind.", "enum": [ "CopyBased", "InPlace" ], "type": "string", - "readOnly": true, "x-ms-enum": { "name": "shareKind", "modelAsString": true } }, - "shareName": { - "description": "Name of the share", - "type": "string", - "readOnly": true - }, - "shareSubscriptionStatus": { - "description": "Gets the current status of share subscription.", - "enum": [ - "Active", - "Revoked", - "SourceDeleted", - "Revoking" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "shareSubscriptionStatus", - "modelAsString": true - } - }, - "shareTerms": { - "description": "Terms of a share", - "type": "string", - "readOnly": true - }, - "sourceShareLocation": { - "description": "Source share location.", + "terms": { + "description": "Share terms.", "type": "string" }, "userEmail": { @@ -4336,8 +4188,8 @@ } } }, - "ShareSubscriptionList": { - "description": "List response for get ShareSubscription.", + "ShareList": { + "description": "List response for get Shares.", "required": [ "value" ], @@ -4352,7 +4204,61 @@ "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/ShareSubscription" + "$ref": "#/definitions/Share" + } + } + } + }, + "ShareSubscriptionSynchronization": { + "description": "A ShareSubscriptionSynchronization data transfer object.", + "required": [ + "synchronizationId" + ], + "type": "object", + "properties": { + "durationMs": { + "format": "int32", + "description": "Synchronization duration", + "type": "integer", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "End time of synchronization", + "type": "string", + "readOnly": true + }, + "message": { + "description": "message of Synchronization", + "type": "string", + "readOnly": true + }, + "startTime": { + "format": "date-time", + "description": "start time of synchronization", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Raw Status", + "type": "string", + "readOnly": true + }, + "synchronizationId": { + "description": "Synchronization id", + "type": "string" + }, + "synchronizationMode": { + "description": "Synchronization Mode", + "enum": [ + "Incremental", + "FullSync" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "synchronizationMode", + "modelAsString": true } } } @@ -4506,74 +4412,168 @@ } } }, - "ShareSubscriptionSynchronization": { - "description": "A ShareSubscriptionSynchronization data transfer object.", + "Synchronize": { + "description": "Payload for the synchronizing the data.", + "type": "object", + "properties": { + "synchronizationMode": { + "description": "Mode of synchronization used in triggers and snapshot sync. Incremental by default", + "enum": [ + "Incremental", + "FullSync" + ], + "type": "string", + "x-ms-enum": { + "name": "synchronizationMode", + "modelAsString": true + } + } + } + }, + "ShareSubscription": { + "description": "A share subscription data transfer object.", "required": [ - "synchronizationId" + "properties" ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyDto" + } + ], "properties": { - "durationMs": { - "format": "int32", - "description": "Synchronization duration", - "type": "integer", + "properties": { + "$ref": "#/definitions/ShareSubscriptionProperties", + "description": "Properties on the share subscription", + "x-ms-client-flatten": true + } + } + }, + "ShareSubscriptionProperties": { + "description": "Share subscription property bag.", + "required": [ + "invitationId", + "sourceShareLocation" + ], + "type": "object", + "properties": { + "createdAt": { + "format": "date-time", + "description": "Time at which the share subscription was created.", + "type": "string", "readOnly": true }, - "endTime": { - "format": "date-time", - "description": "End time of synchronization", + "invitationId": { + "description": "The invitation id.", + "type": "string" + }, + "providerEmail": { + "description": "Email of the provider who created the resource", "type": "string", "readOnly": true }, - "message": { - "description": "message of Synchronization", + "providerName": { + "description": "Name of the provider who created the resource", "type": "string", "readOnly": true }, - "startTime": { - "format": "date-time", - "description": "start time of synchronization", + "providerTenantName": { + "description": "Tenant name of the provider who created the resource", "type": "string", "readOnly": true }, - "status": { - "description": "Raw Status", + "provisioningState": { + "description": "Provisioning state of the share subscription", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Moving", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + }, + "shareDescription": { + "description": "Description of share", "type": "string", "readOnly": true }, - "synchronizationId": { - "description": "Synchronization id", - "type": "string" + "shareKind": { + "description": "Kind of share", + "enum": [ + "CopyBased", + "InPlace" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "shareKind", + "modelAsString": true + } }, - "synchronizationMode": { - "description": "Synchronization Mode", + "shareName": { + "description": "Name of the share", + "type": "string", + "readOnly": true + }, + "shareSubscriptionStatus": { + "description": "Gets the current status of share subscription.", "enum": [ - "Incremental", - "FullSync" + "Active", + "Revoked", + "SourceDeleted", + "Revoking" ], "type": "string", "readOnly": true, "x-ms-enum": { - "name": "synchronizationMode", + "name": "shareSubscriptionStatus", "modelAsString": true } + }, + "shareTerms": { + "description": "Terms of a share", + "type": "string", + "readOnly": true + }, + "sourceShareLocation": { + "description": "Source share location.", + "type": "string" + }, + "userEmail": { + "description": "Email of the user who created the resource", + "type": "string", + "readOnly": true + }, + "userName": { + "description": "Name of the user who created the resource", + "type": "string", + "readOnly": true } } }, - "Synchronize": { - "description": "Payload for the synchronizing the data.", + "ShareSubscriptionList": { + "description": "List response for get ShareSubscription.", + "required": [ + "value" + ], "type": "object", "properties": { - "synchronizationMode": { - "description": "Mode of synchronization used in triggers and snapshot sync. Incremental by default", - "enum": [ - "Incremental", - "FullSync" - ], - "type": "string", - "x-ms-enum": { - "name": "synchronizationMode", - "modelAsString": true + "nextLink": { + "description": "The Url of next result page.", + "type": "string" + }, + "value": { + "description": "Collection of items of type DataTransferObjects.", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/ShareSubscription" } } } From b335ab2f7a8b3f7418526e008eadecfe7d9a623b Mon Sep 17 00:00:00 2001 From: Esha Parmar Date: Thu, 30 Jul 2020 19:08:16 -0700 Subject: [PATCH 14/29] add assignment resource id to the schema (#10309) --- .../stable/2020-06-25/guestconfiguration.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json index 6aacbd66655b..a2a372685861 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json @@ -1250,6 +1250,11 @@ "Pending" ] }, + "resourceId": { + "type": "string", + "readOnly": true, + "description": "Name of the guest configuration assignment resource setting." + }, "reasons": { "type": "array", "items": { From 5699b02c38fc1d90220e7e62c399ea5a5df30b7e Mon Sep 17 00:00:00 2001 From: sotaneja <66496859+sotaneja@users.noreply.github.com> Date: Thu, 30 Jul 2020 19:09:23 -0700 Subject: [PATCH 15/29] Adding Untracked Public Maintenance Config Resource Type (#10281) * Adding Untracked Public Maintenance Config Resource Type * Fixing linter checks --- .../2020-07-01-preview/Maintenance.json | 114 +++++++++++++++++- ...figurations_CreateOrUpdateForResource.json | 14 ++- ...ntenanceConfigurations_GetForResource.json | 7 +- .../MaintenanceConfigurations_List.json | 7 +- ...nanceConfigurations_UpdateForResource.json | 14 ++- ...ntenanceConfigurations_GetForResource.json | 28 +++++ .../PublicMaintenanceConfigurations_List.json | 31 +++++ 7 files changed, 193 insertions(+), 22 deletions(-) create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/PublicMaintenanceConfigurations_GetForResource.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/PublicMaintenanceConfigurations_List.json diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/Maintenance.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/Maintenance.json index e1c82d3f360c..27f506189e74 100644 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/Maintenance.json +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/Maintenance.json @@ -16,6 +16,96 @@ "application/json" ], "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/publicMaintenanceConfigurations": { + "get": { + "tags": [ + "PublicMaintenanceConfigurations" + ], + "summary": "Get Public Maintenance Configuration records", + "operationId": "PublicMaintenanceConfigurations_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListMaintenanceConfigurationsResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "PublicMaintenanceConfigurations_List": { + "$ref": "./examples/PublicMaintenanceConfigurations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/{resourceName}": { + "get": { + "tags": [ + "PublicMaintenanceConfigurations" + ], + "summary": "Get Public Maintenance Configuration record", + "operationId": "PublicMaintenanceConfigurations_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource Identifier", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "PublicMaintenanceConfigurations_GetForResource": { + "$ref": "./examples/PublicMaintenanceConfigurations_GetForResource.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/{applyUpdateName}": { "get": { "tags": [ @@ -1366,11 +1456,11 @@ "type": "object", "properties": { "startDateTime": { - "description": "Effective start date of the maintenance window in YYYY-MM-DD hh:mm:ss format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone.", + "description": "Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone.", "type": "string" }, "expirationDateTime": { - "description": "Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm:ss format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59.", + "description": "Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59.", "type": "string" }, "duration": { @@ -1411,7 +1501,9 @@ "InResource", "OSImage", "Extension", - "InGuestPatch" + "InGuestPatch", + "SQLDB", + "SQLManagedInstance" ], "type": "string", "x-ms-enum": { @@ -1423,6 +1515,18 @@ "$ref": "#/definitions/MaintenanceWindow", "description": "Definition of a MaintenanceWindow", "x-ms-client-flatten": true + }, + "visibility": { + "description": "Gets or sets the visibility of the configuration", + "enum": [ + "Custom", + "Public" + ], + "type": "string", + "x-ms-enum": { + "name": "Visibility", + "modelAsString": true + } } } }, @@ -1574,7 +1678,9 @@ "InResource", "OSImage", "Extension", - "InGuestPatch" + "InGuestPatch", + "SQLDB", + "SQLManagedInstance" ], "type": "string", "x-ms-enum": { diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/MaintenanceConfigurations_CreateOrUpdateForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/MaintenanceConfigurations_CreateOrUpdateForResource.json index e180ac355c35..ecea09029ebc 100644 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/MaintenanceConfigurations_CreateOrUpdateForResource.json +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/MaintenanceConfigurations_CreateOrUpdateForResource.json @@ -8,11 +8,12 @@ "location": "westus2", "properties": { "namespace": "Microsoft.Maintenance", + "visibility": "Custom", "maintenanceScope": "OSImage", "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00:00", - "expirationDateTime": "9999-12-31 00:00:00", - "duration": "05:00:00", + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", "timeZone": "Pacific Standard Time", "recurEvery": "Day" } @@ -27,11 +28,12 @@ "location": "westus2", "properties": { "namespace": "Microsoft.Maintenance", + "visibility": "Custom", "maintenanceScope": "OSImage", "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00:00", - "expirationDateTime": "9999-12-31 00:00:00", - "duration": "05:00:00", + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", "timeZone": "Pacific Standard Time", "recurEvery": "Day" } diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/MaintenanceConfigurations_GetForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/MaintenanceConfigurations_GetForResource.json index c0c8d43171f6..29a0080a4455 100644 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/MaintenanceConfigurations_GetForResource.json +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/MaintenanceConfigurations_GetForResource.json @@ -14,10 +14,11 @@ "properties": { "namespace": "Microsoft.Maintenance", "maintenanceScope": "OSImage", + "visibility": "Custom", "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00:00", - "expirationDateTime": "9999-12-31 00:00:00", - "duration": "05:00:00", + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", "timeZone": "Pacific Standard Time", "recurEvery": "5Days" } diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/MaintenanceConfigurations_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/MaintenanceConfigurations_List.json index c36f3befa15f..844aac01bc32 100644 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/MaintenanceConfigurations_List.json +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/MaintenanceConfigurations_List.json @@ -14,10 +14,11 @@ "properties": { "namespace": "Microsoft.Maintenance", "maintenanceScope": "OSImage", + "visibility": "Custom", "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00:00", - "expirationDateTime": "9999-12-31 00:00:00", - "duration": "05:00:00", + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", "timeZone": "Pacific Standard Time", "recurEvery": "Week Saturday,Sunday" } diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/MaintenanceConfigurations_UpdateForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/MaintenanceConfigurations_UpdateForResource.json index 915e18a49440..c66571d008de 100644 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/MaintenanceConfigurations_UpdateForResource.json +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/MaintenanceConfigurations_UpdateForResource.json @@ -8,11 +8,12 @@ "location": "westus2", "properties": { "namespace": "Microsoft.Maintenance", + "visibility": "Custom", "maintenanceScope": "OSImage", "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00:00", - "expirationDateTime": "9999-12-31 00:00:00", - "duration": "05:00:00", + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", "timeZone": "Pacific Standard Time", "recurEvery": "Month Third Sunday" } @@ -28,10 +29,11 @@ "properties": { "namespace": "Microsoft.Maintenance", "maintenanceScope": "OSImage", + "visibility": "Custom", "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00:00", - "expirationDateTime": "9999-12-31 00:00:00", - "duration": "05:00:00", + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", "timeZone": "Pacific Standard Time", "recurEvery": "Month Third Sunday" } diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/PublicMaintenanceConfigurations_GetForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/PublicMaintenanceConfigurations_GetForResource.json new file mode 100644 index 000000000000..477e2a295e7a --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/PublicMaintenanceConfigurations_GetForResource.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceName": "configuration1", + "api-version": "2020-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "SQLDB", + "visibility": "Public", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "2Weeks" + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/PublicMaintenanceConfigurations_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/PublicMaintenanceConfigurations_List.json new file mode 100644 index 000000000000..67313ccf7166 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/preview/2020-07-01-preview/examples/PublicMaintenanceConfigurations_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2020-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "SQLDB", + "visibility": "Public", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00:00", + "expirationDateTime": "9999-12-31 00:00:00", + "duration": "05:00:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Week Saturday,Sunday" + } + } + } + ] + } + } + } +} From f50289e455d6c282df77fe989d75cedbf78133b3 Mon Sep 17 00:00:00 2001 From: "[MSFT] Bowen Wan" Date: Fri, 31 Jul 2020 11:21:56 +0800 Subject: [PATCH 16/29] [Hub Generated] Review request for Microsoft.AppPlatform to add version preview/2019-05-01-preview (#10302) * Fix swagger by adding readonly for properties. * Update samples. --- .../preview/2019-05-01-preview/appplatform.json | 9 ++++++--- .../examples/Bindings_CreateOrUpdate.json | 2 -- .../2019-05-01-preview/examples/Bindings_Update.json | 2 -- .../examples/CustomDomains_CreateOrUpdate.json | 1 - .../2019-05-01-preview/examples/CustomDomains_Patch.json | 1 - 5 files changed, 6 insertions(+), 9 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 773e65c8d69f..e9020e72f54f 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 @@ -2792,11 +2792,13 @@ "properties": { "resourceName": { "description": "The name of the bound resource", - "type": "string" + "type": "string", + "readOnly": true }, "resourceType": { "description": "The standard Azure resource type of the bound resource", - "type": "string" + "type": "string", + "readOnly": true }, "resourceId": { "description": "The Azure resource id of the bound resource", @@ -3006,7 +3008,8 @@ }, "appName": { "description": "The app name of domain.", - "type": "string" + "type": "string", + "readOnly": true }, "certName": { "description": "The bound certificate name of domain.", diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Bindings_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Bindings_CreateOrUpdate.json index e426c806b855..b989e5a57739 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Bindings_CreateOrUpdate.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Bindings_CreateOrUpdate.json @@ -2,8 +2,6 @@ "parameters": { "bindingResource": { "properties": { - "resourceName": "my-cosmosdb-1", - "resourceType": "Microsoft.DocumentDB", "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.DocumentDB/databaseAccounts/my-cosmosdb-1", "key": "xxxx", "bindingParameters": { diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Bindings_Update.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Bindings_Update.json index d2e0c8a715ea..0d7889bef1de 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Bindings_Update.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Bindings_Update.json @@ -2,8 +2,6 @@ "parameters": { "bindingResource": { "properties": { - "resourceName": null, - "resourceType": null, "key": "xxxx", "bindingParameters": { "databaseName": "db1", diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_CreateOrUpdate.json index 213fb3296173..4d2893ff6ad2 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_CreateOrUpdate.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_CreateOrUpdate.json @@ -3,7 +3,6 @@ "domainResource": { "properties": { "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133", - "appName": "myapp", "certName": "mycert" } }, diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_Patch.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_Patch.json index 213fb3296173..4d2893ff6ad2 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_Patch.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/CustomDomains_Patch.json @@ -3,7 +3,6 @@ "domainResource": { "properties": { "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133", - "appName": "myapp", "certName": "mycert" } }, From 3d12d70d765934c2f59d1d1d3eb4485719c04361 Mon Sep 17 00:00:00 2001 From: Pradeep Kintali <50682039+pradeepkintali@users.noreply.github.com> Date: Thu, 30 Jul 2020 20:37:41 -0700 Subject: [PATCH 17/29] Added swagger files for PostgreSQL Flexible Server preview (#10020) * Initial swagger changes for SSPG. * Successfully validated the postgresql.json * Create different properties for Create and Update * Updated the Firewall rules api's. * Added Customer maintenance Window Get operation. * Added Delete operation for CMW * Added put API for CMW. * Added PITR API. * Fix for avocado and Spellcheck validations * Fixed the prettier check issues. * Fixed model validaiton error for Create * Fixed FirewallRuls_Create model validation * Fixed ConfigurationUpdate example json * Fixed Firewall Rules Get API * Fixed prettier issues for Configuration Update. * Fixed Update configuration schema * Fixed Create PITR server schema * Fixed semantic validations * Fixed Lint Diff errors * Removed next links * resolved code review comments * resolved code review comments * added the state properties * Fixed the server update example. * Resolved few code review comments * added pagination for all list operations. * Updated the CMW API Contracts. * rename from singleServers to flexibleServers * Updated cloud error body to common types. * Fixed lint errors. * Fixed the prettier * Revert "Fixed the prettier" This reverts commit 5140f06a4f4b159b4894eaa70e5b268984de91f5. * Revert "Fixed lint errors." This reverts commit fe5494254f1eb23a290c1cfeb6a26bd907a6e23e. * Fixed new lint errors * state property name changes * Fixed the model validation errors * Fixed server list by resource group * publicIpAddressRequested to publicNetworkAccess * Added storage profile and Sku * Added Burstable as custom word. * Fix for R3020 PathResourceProviderNamePascalCase * Microsoft.DBForPostgreSQL to Microsoft.DBForPostgreSql * Fixed Lint errors R2016, R4010 * Fix for R2020 * Change names for Operation Ids. * Marked fields as readonly and LintDiff Error * Fixed model validation errors * Fixed lint diff * Fixed the Comments for Server object create * changed the put to post for update configurations * Removed the Confgiration Update for now --- custom-words.txt | 1 + .../examples/CheckNameAvailability.json | 20 + .../examples/ConfigurationGet.json | 26 + .../examples/ConfigurationListByServer.json | 1902 +++++++++++++++++ .../CustomerMaintenanceWindowCreate.json | 46 + .../CustomerMaintenanceWindowDelete.json | 14 + .../CustomerMaintenanceWindowGet.json | 24 + ...CustomerMaintenanceWindowListByServer.json | 27 + .../examples/FirewallRuleCreate.json | 40 + .../examples/FirewallRuleDelete.json | 14 + .../examples/FirewallRuleGet.json | 22 + .../examples/FirewallRuleListByServer.json | 35 + .../examples/OperationList.json | 176 ++ .../examples/ServerCreate.json | 107 + .../ServerCreatePointInTimeRestore.json | 81 + .../examples/ServerDelete.json | 13 + .../examples/ServerGet.json | 39 + .../examples/ServerGetWithVnet.json | 44 + .../examples/ServerList.json | 123 ++ .../examples/ServerListByResourceGroup.json | 91 + .../examples/ServerRestart.json | 12 + .../examples/ServerStart.json | 12 + .../examples/ServerStop.json | 12 + .../examples/ServerUpdate.json | 56 + .../2020-02-14-privatepreview/postgresql.json | 1640 ++++++++++++++ .../postgresql/resource-manager/readme.md | 11 + 26 files changed, 4588 insertions(+) create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CheckNameAvailability.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ConfigurationGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ConfigurationListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowCreate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowGet.json create 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/FirewallRuleCreate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/FirewallRuleDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/FirewallRuleGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/FirewallRuleListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/OperationList.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerCreate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerCreatePointInTimeRestore.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerDelete.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerGetWithVnet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerList.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerListByResourceGroup.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerRestart.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerStart.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerStop.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerUpdate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json diff --git a/custom-words.txt b/custom-words.txt index 741cf68d8cf1..7cfe2a125bc6 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -239,6 +239,7 @@ brazilsouth browsable bruceper Bsaling +Burstable BYOC BYOK BYOL diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CheckNameAvailability.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..8edb7b34471d --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2020-02-14-privatepreview", + "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-privatepreview/examples/ConfigurationGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ConfigurationGet.json new file mode 100644 index 000000000000..55890a1e6df0 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ConfigurationGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "configurationName": "array_nulls", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2017-12-01", + "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-privatepreview/examples/ConfigurationListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ConfigurationListByServer.json new file mode 100644 index 000000000000..2cf125c8d12a --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ConfigurationListByServer.json @@ -0,0 +1,1902 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-privatepreview", + "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-privatepreview/examples/CustomerMaintenanceWindowCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowCreate.json new file mode 100644 index 000000000000..648e0befb9a2 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowCreate.json @@ -0,0 +1,46 @@ +{ + "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 new file mode 100644 index 000000000000..cafa0a76ed07 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowDelete.json @@ -0,0 +1,14 @@ +{ + "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 new file mode 100644 index 000000000000..8febc0a4b487 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowGet.json @@ -0,0 +1,24 @@ +{ + "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 new file mode 100644 index 000000000000..aff335545a5c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/CustomerMaintenanceWindowListByServer.json @@ -0,0 +1,27 @@ +{ + "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/FirewallRuleCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/FirewallRuleCreate.json new file mode 100644 index 000000000000..08347b10a459 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/FirewallRuleCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-privatepreview", + "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-privatepreview/examples/FirewallRuleDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/FirewallRuleDelete.json new file mode 100644 index 000000000000..7210184118b1 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/FirewallRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "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/FirewallRuleGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/FirewallRuleGet.json new file mode 100644 index 000000000000..bafbaea55717 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/FirewallRuleGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "firewallRuleName": "rule1", + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-privatepreview", + "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-privatepreview/examples/FirewallRuleListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/FirewallRuleListByServer.json new file mode 100644 index 000000000000..d4c80afd0a6e --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/FirewallRuleListByServer.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-privatepreview", + "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-privatepreview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/OperationList.json new file mode 100644 index 000000000000..af13889175e0 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/OperationList.json @@ -0,0 +1,176 @@ +{ + "parameters": { + "api-version": "2020-02-14-privatepreview" + }, + "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-privatepreview/examples/ServerCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerCreate.json new file mode 100644 index 000000000000..3c3908a9039a --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerCreate.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "testrg", + "api-version": "2020-02-14-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "sku": { + "tier": "GeneralPurpose", + "capacity": 4, + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "administratorLoginPassword": "password", + "version": "12", + "standbyCount": 0, + "vnetInjArgs": { + "delegatedSubnetName": "test-subnet", + "delegatedVnetID": "6ed504a3-24b8-4ba8-ac1f-7a1780195437", + "delegatedVnetName": "test-vnet" + }, + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + } + }, + "tags": { + "ElasticServer": "1" + } + } + }, + "responses": { + "201": { + "body": { + "sku": { + "tier": "GeneralPurpose", + "capacity": 4, + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "NotEnabled", + "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" + }, + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + } + }, + "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", + "capacity": 4, + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "NotEnabled", + "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" + }, + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + } + }, + "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/ServerCreatePointInTimeRestore.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerCreatePointInTimeRestore.json new file mode 100644 index 000000000000..37fbec167d04 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerCreatePointInTimeRestore.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-privatepreview", + "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", + "capacity": 4, + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "NotEnabled", + "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "standbyCount": 0, + "vnetInjArgs": {}, + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + } + }, + "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", + "capacity": 4, + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "NotEnabled", + "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Enabled", + "standbyCount": 0, + "vnetInjArgs": {}, + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + } + }, + "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/ServerDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerDelete.json new file mode 100644 index 000000000000..4f1c212e5e92 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "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/ServerGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerGet.json new file mode 100644 index 000000000000..fdb65ca0219c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "serverName": "pgtestsvc1", + "resourceGroupName": "testrg", + "api-version": "2020-02-14-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "GeneralPurpose", + "capacity": 4, + "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 + } + }, + "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-privatepreview/examples/ServerGetWithVnet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerGetWithVnet.json new file mode 100644 index 000000000000..639fb674d91a --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerGetWithVnet.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "serverName": "pgtestsvc1", + "resourceGroupName": "testrg", + "api-version": "2020-02-14-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "GeneralPurpose", + "capacity": 4, + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLogin": "cloudsa", + "version": "12", + "state": "Ready", + "haState": "NotEnabled", + "fullyQualifiedDomainName": "pgtestsvc4.postgres.database.azure.com", + "displayName": "demosingleserver", + "publicNetworkAccess": "Disabled", + "vnetInjArgs": { + "delegatedSubnetName": "test-subnet", + "delegatedVnetID": "6ed504a3-24b8-4ba8-ac1f-7a1780195437", + "delegatedVnetName": "test-vnet" + }, + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 7 + } + }, + "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-privatepreview/examples/ServerList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerList.json new file mode 100644 index 000000000000..c45b4e7331f2 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerList.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "api-version": "2020-02-14-privatepreview", + "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", + "capacity": 4, + "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 + } + }, + "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", + "capacity": 4, + "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 + } + }, + "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", + "capacity": 4, + "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 + } + }, + "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", + "capacity": 4, + "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 + } + }, + "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-privatepreview/examples/ServerListByResourceGroup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerListByResourceGroup.json new file mode 100644 index 000000000000..eb147eed2fbf --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerListByResourceGroup.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2020-02-14-privatepreview", + "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", + "capacity": 4, + "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 + } + }, + "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", + "capacity": 4, + "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 + } + }, + "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", + "capacity": 4, + "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 + } + }, + "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-privatepreview/examples/ServerRestart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerRestart.json new file mode 100644 index 000000000000..529712063a59 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerRestart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerStart.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerStart.json new file mode 100644 index 000000000000..529712063a59 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerStart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerStop.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerStop.json new file mode 100644 index 000000000000..529712063a59 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerStop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "serverName": "testserver", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" + }, + "responses": { + "200": {}, + "202": {} + } +} 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 new file mode 100644 index 000000000000..9340c6e76e9b --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/examples/ServerUpdate.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "serverName": "pgtestsvc4", + "resourceGroupName": "TestGroup", + "api-version": "2020-02-14-privatepreview", + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "parameters": { + "location": "westus", + "sku": { + "tier": "GeneralPurpose", + "capacity": 4, + "name": "Standard_D4s_v3" + }, + "properties": { + "administratorLoginPassword": "newpassword", + "storageProfile": { + "storageMB": 524288, + "backupRetentionDays": 20 + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "GeneralPurpose", + "capacity": 4, + "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 + }, + "vnetInjArgs": {} + }, + "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/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json new file mode 100644 index 000000000000..8d350737eb01 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json @@ -0,0 +1,1640 @@ +{ + "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-privatepreview" + }, + "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": "FlexibleServers_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": "FlexibleServers_Update", + "x-ms-examples": { + "ServerUpdate": { + "$ref": "./examples/ServerUpdate.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": "FlexibleServers_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": "FlexibleServers_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": "FlexibleServers_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": "FlexibleServers_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": "FlexibleServers_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": "FlexibleServers_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": "FlexibleServers_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": "FlexibleServersFirewallRules_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": "FlexibleServersFirewallRules_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": "FlexibleServersFirewallRules_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": "FlexibleServersConfigurations_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": "FlexibleServersConfigurations_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" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers/{serverName}/maintenanceWindows/{maintenanceWindowName}": { + "put": { + "tags": [ + "CustomerMaintenanceWindow" + ], + "operationId": "FlexibleServersCustomerMaintenanceWindow_CreateOrUpdate", + "x-ms-examples": { + "CustomerMaintenanceWindowCreate": { + "$ref": "./examples/CustomerMaintenanceWindowCreate.json" + } + }, + "description": "Creates a new customer 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/CustomerMaintenanceWindow" + }, + "description": "The required parameters for creating or updating a customer maintenance window." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomerMaintenanceWindow" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CustomerMaintenanceWindow" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "CustomerMaintenanceWindow" + ], + "operationId": "FlexibleServersCustomerMaintenanceWindow_Delete", + "x-ms-examples": { + "CustomerMaintenanceWindowDelete": { + "$ref": "./examples/CustomerMaintenanceWindowDelete.json" + } + }, + "description": "Deletes a PostgreSQL server Customer 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 + }, + "get": { + "tags": [ + "CustomerMaintenanceWindow" + ], + "operationId": "FlexibleServersCustomerMaintenanceWindow_Get", + "x-ms-examples": { + "CustomerMaintenanceWindowGet": { + "$ref": "./examples/CustomerMaintenanceWindowGet.json" + } + }, + "description": "Get the Customer maintenance windows of 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" + }, + { + "$ref": "#/parameters/MaintenanceWindowNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CustomerMaintenanceWindow" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/flexibleServers/{serverName}/maintenanceWindows": { + "get": { + "tags": [ + "CustomerMaintenanceWindow" + ], + "operationId": "FlexibleServersCustomerMaintenanceWindow_ListByServer", + "x-ms-examples": { + "CustomerMaintenanceWindowList": { + "$ref": "./examples/CustomerMaintenanceWindowListByServer.json" + } + }, + "description": "List all the Customer Maintenance Windows 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/CustomerMaintenanceWindowListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DBForPostgreSql/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "operationId": "FlexibleServersCheckNameAvailability_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" + } + } + } + } + }, + "/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": { + "ServerVersion": { + "type": "string", + "description": "The version of a server.", + "enum": [ + "12" + ], + "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 + } + }, + "standbyCount": { + "type": "integer", + "format": "int32", + "description": "stand by count value can be either 0 or 1" + }, + "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." + }, + "vnetInjArgs": { + "properties": { + "delegatedVnetID": { + "type": "string", + "description": "delegated vNet ID" + }, + "delegatedSubnetName": { + "type": "string", + "description": "delegated subnet name" + }, + "delegatedVnetName": { + "type": "string", + "description": "delegated vNet name" + } + } + }, + "createMode": { + "type": "string", + "description": "The mode to create a new PostgreSQL server.", + "enum": [ + "Default", + "PointInTimeRestore" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + } + } + }, + "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." + }, + "ServerPropertiesForUpdate": { + "properties": { + "administratorLoginPassword": { + "type": "string", + "format": "password", + "description": "The password of the administrator login." + }, + "version": { + "$ref": "#/definitions/ServerVersion", + "description": "PostgreSQL Server version." + }, + "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" + }, + "serverEdition": { + "type": "string", + "description": "server edition default to general purpose" + } + } + }, + "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": false, + "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 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 + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "The scale up/out capacity, representing server's compute units." + } + }, + "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." + }, + "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": { + "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." + }, + "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": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "The list of resource provider operations." + } + }, + "description": "A list of resource provider operations." + }, + "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": { + "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.md b/specification/postgresql/resource-manager/readme.md index 103327a277e4..fff38f5d4148 100644 --- a/specification/postgresql/resource-manager/readme.md +++ b/specification/postgresql/resource-manager/readme.md @@ -31,6 +31,16 @@ openapi-type: arm tag: package-2020-01-01 ``` +### Tag: package-2020-02-14-privatepreview + +These settings apply only when `--tag=package-2020-02-14-privatepreview` is specified on the command line. + + +``` yaml $(tag) == 'package-2020-02-14-privatepreview' +input-file: +- Microsoft.DBforPostgreSQL/preview/2020-02-14-privatepreview/postgresql.json +``` + ### Tag: package-2020-01-01-privatepreview These settings apply only when `--tag=package-2020-01-01-privatepreview` is specified on the command line. @@ -92,6 +102,7 @@ input-file: - Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json ``` + ### Tag: package-2017-12-01 These settings apply only when `--tag=package-2017-12-01` is specified on the command line. From cfd53fbb24ddb3551abddf6f1096983378e9e1e2 Mon Sep 17 00:00:00 2001 From: yuzhangyi <44692931+yuzhangyi@users.noreply.github.com> Date: Fri, 31 Jul 2020 14:52:15 +0800 Subject: [PATCH 18/29] [DataFactory] Support source sink level staging (#10290) * Enable excel in public swagger * update * rollback dataflow change * Support source/sink level staging in dataflow Co-authored-by: zhanyu2014 --- .../stable/2018-06-01/entityTypes/DataFlow.json | 8 ++++++++ 1 file changed, 8 insertions(+) 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..d06e5e38b08b 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 @@ -121,6 +121,10 @@ "schemaLinkedService": { "description": "Schema linked service reference.", "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "staging": { + "description": "Staging info for execute data flow activity.", + "$ref": "../datafactory.json#/definitions/DataFlowStagingInfo" } } }, @@ -143,6 +147,10 @@ "schemaLinkedService": { "description": "Schema linked service reference.", "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "staging": { + "description": "Staging info for execute data flow activity.", + "$ref": "../datafactory.json#/definitions/DataFlowStagingInfo" } } } From cfa39b489c258e4408db278566a7b2c33d829059 Mon Sep 17 00:00:00 2001 From: deepak-muniappan <36715417+deepak-muniappan@users.noreply.github.com> Date: Sat, 1 Aug 2020 06:20:48 -0700 Subject: [PATCH 19/29] New Api version 2020-06-15- fixing certificate put/get issues with ARM (#10251) * Adds base for updating Microsoft.Devices from version stable/2020-04-01 to version 2020-06-15 * Updates readme * Updates API version in new specs and examples * Add cert changes * Fix examples * remove unnecessary model * fix the createcert * Fix the put certificate body * Fix the certificate example * Fix the braces * Fix the certificateDescription case * Prettify Json * Update consumer group properties PUT schema * Rename schema prop name for cg body Co-authored-by: Rajasekharan Vengalil --- .../examples/IotHub_ManualFailover.json | 15 + .../examples/checkNameAvailability.json | 20 + .../iothub_certificatescreateorupdate.json | 50 + .../examples/iothub_certificatesdelete.json | 14 + .../examples/iothub_certverify.json | 31 + .../examples/iothub_createOrUpdate.json | 226 + .../examples/iothub_createconsumergroup.json | 28 + .../2020-06-15/examples/iothub_delete.json | 164 + .../examples/iothub_deleteconsumergroup.json | 13 + ...othub_deleteprivateendpointconnection.json | 46 + .../examples/iothub_exportdevices.json | 23 + .../iothub_generateverificationcode.json | 26 + .../2020-06-15/examples/iothub_get.json | 96 + .../examples/iothub_getcertificate.json | 28 + .../examples/iothub_getconsumergroup.json | 23 + .../2020-06-15/examples/iothub_getjob.json | 20 + .../2020-06-15/examples/iothub_getkey.json | 19 + .../iothub_getprivateendpointconnection.json | 28 + .../iothub_getprivatelinkresources.json | 27 + .../2020-06-15/examples/iothub_getskus.json | 53 + .../examples/iothub_importdevices.json | 23 + .../2020-06-15/examples/iothub_listbyrg.json | 90 + .../examples/iothub_listbysubscription.json | 89 + .../examples/iothub_listcertificates.json | 31 + .../examples/iothub_listehgroups.json | 26 + .../2020-06-15/examples/iothub_listjobs.json | 23 + .../2020-06-15/examples/iothub_listkeys.json | 46 + ...iothub_listprivateendpointconnections.json | 29 + .../iothub_listprivatelinkresources.json | 30 + .../examples/iothub_operations.json | 328 ++ .../2020-06-15/examples/iothub_patch.json | 95 + .../examples/iothub_quotametrics.json | 26 + .../iothub_routingendpointhealth.json | 34 + .../2020-06-15/examples/iothub_stats.json | 17 + .../examples/iothub_testallroutes.json | 38 + .../examples/iothub_testnewroute.json | 52 + ...othub_updateprivateendpointconnection.json | 53 + .../2020-06-15/examples/iothub_usages.json | 25 + .../stable/2020-06-15/iothub.json | 4196 +++++++++++++++++ .../iothub/resource-manager/readme.md | 13 +- 40 files changed, 6212 insertions(+), 2 deletions(-) create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/IotHub_ManualFailover.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/checkNameAvailability.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_certificatescreateorupdate.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_certificatesdelete.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_certverify.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_createOrUpdate.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_createconsumergroup.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_delete.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_deleteconsumergroup.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_deleteprivateendpointconnection.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_exportdevices.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_generateverificationcode.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_get.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getcertificate.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getconsumergroup.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getjob.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getkey.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getprivateendpointconnection.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getprivatelinkresources.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getskus.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_importdevices.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listbyrg.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listbysubscription.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listcertificates.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listehgroups.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listjobs.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listkeys.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listprivateendpointconnections.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listprivatelinkresources.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_operations.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_patch.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_quotametrics.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_routingendpointhealth.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_stats.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_testallroutes.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_testnewroute.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_updateprivateendpointconnection.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_usages.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/iothub.json diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/IotHub_ManualFailover.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/IotHub_ManualFailover.json new file mode 100644 index 000000000000..e0e2f963ea15 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/IotHub_ManualFailover.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "failoverInput": { + "failoverRegion": "testHub" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/checkNameAvailability.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/checkNameAvailability.json new file mode 100644 index 000000000000..11f189481131 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/checkNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "operationInputs": { + "name": "test-request" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "Invalid", + "message": "" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_certificatescreateorupdate.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_certificatescreateorupdate.json new file mode 100644 index 000000000000..a529084ef640 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_certificatescreateorupdate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "resourceName": "iothub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "certificateDescription": { + "properties": { + "certificate": "############################################" + } + } + }, + "responses": { + "201": { + "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", + "certificate": "############################################" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + }, + "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", + "certificate": "############################################" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_certificatesdelete.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_certificatesdelete.json new file mode 100644 index 000000000000..aa01695622a9 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_certificatesdelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceName": "myhub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_certverify.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_certverify.json new file mode 100644 index 000000000000..8495b68332d3 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_certverify.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=", + "certificateVerificationBody": { + "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/IotHubs/Certificates", + "etag": "AAAAAAExpTQ=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_createOrUpdate.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_createOrUpdate.json new file mode 100644 index 000000000000..605b91aa578d --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_createOrUpdate.json @@ -0,0 +1,226 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "iotHubDescription": { + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "ipFilterRules": [], + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2 + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None", + "minTlsVersion": "1.2" + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [], + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None", + "minTlsVersion": "1.2" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [], + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None", + "minTlsVersion": "1.2" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_createconsumergroup.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_createconsumergroup.json new file mode 100644 index 000000000000..0d977b3a70ba --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_createconsumergroup.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "name": "test", + "consumerGroupBody": { + "properties": { + "name": "test" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "created": "Thu, 15 Jun 2017 19:20:58 GMT" + }, + "id": "/subscriptions/cmd-sub-1/resourceGroups/cmd-rg-1/providers/Microsoft.Devices/IotHubs/test-hub-2/eventHubEndpoints/events/ConsumerGroups/%24Default", + "name": "test", + "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups", + "etag": "AAAAAAFD6M4=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_delete.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_delete.json new file mode 100644 index 000000000000..decd68cd83e4 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_delete.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [], + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + }, + "204": {}, + "202": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [], + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + }, + "404": { + "body": {} + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_deleteconsumergroup.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_deleteconsumergroup.json new file mode 100644 index 000000000000..098401a3364e --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_deleteconsumergroup.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "name": "test" + }, + "responses": { + "200": {} + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_deleteprivateendpointconnection.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_deleteprivateendpointconnection.json new file mode 100644 index 000000000000..2e17f1acbb7d --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_deleteprivateendpointconnection.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/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/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/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/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_exportdevices.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_exportdevices.json new file mode 100644 index 000000000000..8a5f28ef97f9 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_exportdevices.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "exportDevicesParameters": { + "exportBlobContainerUri": "testBlob", + "excludeKeys": true + } + }, + "responses": { + "200": { + "body": { + "jobId": "test", + "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "type": "unknown", + "status": "unknown" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_generateverificationcode.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_generateverificationcode.json new file mode 100644 index 000000000000..b369c7ebaf09 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_generateverificationcode.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "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/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_get.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_get.json new file mode 100644 index 000000000000..f6111e329334 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_get.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [], + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None", + "locations": [ + { + "location": "West US", + "role": "primary" + }, + { + "location": "East US", + "role": "secondary" + } + ], + "minTlsVersion": "1.2" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getcertificate.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getcertificate.json new file mode 100644 index 000000000000..6a231eaa8dc8 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getcertificate.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceName": "testhub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "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", + "certificate": "############################################" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getconsumergroup.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getconsumergroup.json new file mode 100644 index 000000000000..92eeaa92eb31 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getconsumergroup.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "name": "test" + }, + "responses": { + "200": { + "body": { + "properties": { + "created": "Thu, 15 Jun 2017 19:20:58 GMT" + }, + "id": "/subscriptions/cmd-sub-1/resourceGroups/cmd-rg-1/providers/Microsoft.Devices/IotHubs/test-hub-2/eventHubEndpoints/events/ConsumerGroups/%24Default", + "name": "test", + "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups", + "etag": "AAAAAAFD6M4=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getjob.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getjob.json new file mode 100644 index 000000000000..92cd774970c8 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getjob.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "jobId": "test" + }, + "responses": { + "200": { + "body": { + "jobId": "test", + "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "type": "unknown", + "status": "unknown" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getkey.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getkey.json new file mode 100644 index 000000000000..56513e2f88b9 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getkey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "keyName": "iothubowner" + }, + "responses": { + "200": { + "body": { + "keyName": "iothubowner", + "primaryKey": "2aWPrKloLLdcug12ZHNpA0e07yJmRRmYMXDLpEOTd/Y=", + "secondaryKey": "DLyFnDTGMDK0BU2QjT5TCkNBQ4h08mi20vOqWMC7TxU=", + "rights": "RegistryWrite, ServiceConnect, DeviceConnect" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getprivateendpointconnection.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getprivateendpointconnection.json new file mode 100644 index 000000000000..3a0e1460d5f6 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getprivateendpointconnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/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/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getprivatelinkresources.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getprivatelinkresources.json new file mode 100644 index 000000000000..091b5b94570e --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getprivatelinkresources.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "groupId": "iotHub" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateLinkResources/iotHub", + "name": "iotHub", + "type": "Microsoft.Devices/IotHubs/PrivateLinkResources", + "properties": { + "groupId": "iotHub", + "requiredMembers": [ + "iotHub" + ], + "requiredZoneNames": [ + "privatelink.azure-devices.net" + ] + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getskus.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getskus.json new file mode 100644 index 000000000000..c1b93808e018 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_getskus.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.Devices/IotHubs", + "sku": { + "name": "S1", + "tier": "Standard" + }, + "capacity": { + "default": 1, + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.Devices/IotHubs", + "sku": { + "name": "S2", + "tier": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 200, + "default": 1, + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.Devices/IotHubs", + "sku": { + "name": "S3", + "tier": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 10, + "default": 1, + "scaleType": "Manual" + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_importdevices.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_importdevices.json new file mode 100644 index 000000000000..97687dc75077 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_importdevices.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "importDevicesParameters": { + "inputBlobContainerUri": "testBlob", + "outputBlobContainerUri": "testBlob" + } + }, + "responses": { + "200": { + "body": { + "jobId": "test", + "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "type": "unknown", + "status": "unknown" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listbyrg.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listbyrg.json new file mode 100644 index 000000000000..38afa1cc2d15 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listbyrg.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [], + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listbysubscription.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listbysubscription.json new file mode 100644 index 000000000000..27bca11bd35d --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listbysubscription.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "resourceName": "testHub", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [], + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listcertificates.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listcertificates.json new file mode 100644 index 000000000000..78edce3e7d0d --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listcertificates.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceName": "testhub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "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", + "certificate": "############################################" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listehgroups.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listehgroups.json new file mode 100644 index 000000000000..798a50cdd48b --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listehgroups.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "created": "Thu, 15 Jun 2017 19:20:58 GMT" + }, + "id": "/subscriptions/cmd-sub-1/resourceGroups/cmd-rg-1/providers/Microsoft.Devices/IotHubs/test-hub-2/eventHubEndpoints/events/ConsumerGroups/%24Default", + "name": "$Default", + "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups", + "etag": "AAAAAAFD6M4=" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listjobs.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listjobs.json new file mode 100644 index 000000000000..b6a53041805b --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listjobs.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "jobId": "test", + "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "type": "unknown", + "status": "unknown" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listkeys.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listkeys.json new file mode 100644 index 000000000000..424300839237 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listkeys.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "keyName": "iothubowner", + "primaryKey": "2aWPrKloLLdcug12ZHNpA0e07yJmRRmYMXDLpEOTd/Y=", + "secondaryKey": "DLyFnDTGMDK0BU2QjT5TCkNBQ4h08mi20vOqWMC7TxU=", + "rights": "RegistryWrite, ServiceConnect, DeviceConnect" + }, + { + "keyName": "service", + "primaryKey": "DinqxWW+s814W2Pc3dLxleelksqSYGy8Jfymt8J7a4c=", + "secondaryKey": "5G8KgJ9Wx2T0f6HRIn25TgYcFmJnBSivawNaHssiP9Y=", + "rights": "ServiceConnect" + }, + { + "keyName": "device", + "primaryKey": "o/9gPc0oD8LY/r2lRurgl9U/sKFcL2c/tmFLKAiz+e0=", + "secondaryKey": "YOeBMHnYP95vH+ykR8OeapnhS6W8raMsXOdNFwqg4lg=", + "rights": "DeviceConnect" + }, + { + "keyName": "registryRead", + "primaryKey": "h2d4mPxy6jPCWX6mO+katV9QPNJivzt4aFq0iGVc1A8=", + "secondaryKey": "3TdcalZNTB7BZHl88LGsG1Z5T6+ElEODunrs1vylwGg=", + "rights": "RegistryRead" + }, + { + "keyName": "registryReadWrite", + "primaryKey": "tyNRcaI38fXL+gQTjCmrVZGTP4YFF7uACk7pppWLWzY=", + "secondaryKey": "6P6DXOp0W3HO5/IotzcPS1kx7PHiOdesaND07Im5cYI=", + "rights": "RegistryWrite" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listprivateendpointconnections.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listprivateendpointconnections.json new file mode 100644 index 000000000000..c545d559e1b2 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listprivateendpointconnections.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/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/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listprivatelinkresources.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listprivatelinkresources.json new file mode 100644 index 000000000000..2164528fde41 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_listprivatelinkresources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateLinkResources/iotHub", + "name": "iotHub", + "type": "Microsoft.Devices/IotHubs/PrivateLinkResources", + "properties": { + "groupId": "iotHub", + "requiredMembers": [ + "iotHub" + ], + "requiredZoneNames": [ + "privatelink.azure-devices.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_operations.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_operations.json new file mode 100644 index 000000000000..93d80c5d4647 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_operations.json @@ -0,0 +1,328 @@ +{ + "parameters": { + "api-version": "2020-06-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Devices/register/action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Register Resource Provider", + "description": "Register the subscription for the IotHub resource provider and enables the creation of IotHub resources" + } + }, + { + "name": "Microsoft.Devices/IotHubs/diagnosticSettings/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Diagnostic Setting", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "name": "Microsoft.Devices/IotHubs/diagnosticSettings/write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Set Diagnostic Setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + }, + { + "name": "Microsoft.Devices/IotHubs/metricDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read IotHub service metric definitions", + "description": "Gets the available metrics for the IotHub service" + } + }, + { + "name": "Microsoft.Devices/IotHubs/logDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read IotHub service log definitions", + "description": "Gets the available log definitions for the IotHub Service" + } + }, + { + "name": "Microsoft.Devices/operations/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get All ResourceProvider Operations", + "description": "Get All ResourceProvider Operations" + } + }, + { + "name": "Microsoft.Devices/checkNameAvailability/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Check If IotHub name is available", + "description": "Check If IotHub name is available" + } + }, + { + "name": "Microsoft.Devices/usages/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Subscription Usages", + "description": "Get subscription usage details for this provider." + } + }, + { + "name": "Microsoft.Devices/iotHubs/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub(s)", + "description": "Gets the IotHub resource(s)" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Create or update IotHub Resource", + "description": "Create or update IotHub Resource" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Delete IotHub Resource", + "description": "Delete IotHub Resource" + } + }, + { + "name": "Microsoft.Devices/iotHubs/iotHubStats/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub Statistics", + "description": "Get IotHub Statistics" + } + }, + { + "name": "Microsoft.Devices/iotHubs/skus/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get valid IotHub Skus", + "description": "Get valid IotHub Skus" + } + }, + { + "name": "Microsoft.Devices/iotHubs/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get all IotHub Keys", + "description": "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", + "description": "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", + "description": "Create EventHub Consumer Group" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get EventHub Consumer Group(s)", + "description": "Get EventHub Consumer Group(s)" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Delete EventHub Consumer Group", + "description": "Delete EventHub Consumer Group" + } + }, + { + "name": "Microsoft.Devices/iotHubs/exportDevices/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Export Devices", + "description": "Export Devices" + } + }, + { + "name": "Microsoft.Devices/iotHubs/importDevices/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Import Devices", + "description": "Import Devices" + } + }, + { + "name": "Microsoft.Devices/iotHubs/jobs/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get the Job(s) on IotHub", + "description": "Get Job(s) details submitted on given IotHub" + } + }, + { + "name": "Microsoft.Devices/iotHubs/quotaMetrics/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Quota Metrics", + "description": "Get Quota Metrics" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routing/routes/$testall/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Routing Rule Test All", + "description": "Test a message against all existing Routes" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routing/routes/$testnew/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Routing Rule Test Route", + "description": "Test a message against a provided test Route" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routingEndpointsHealth/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Endpoint Health", + "description": "Gets the health of all routing Endpoints for an IotHub" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Diagnostic Setting", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Set Diagnostic Setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/metricDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read DPS service metric definitions", + "description": "Gets the available metrics for the DPS service" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/logDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read DPS service log definitions", + "description": "Gets the available log definitions for the DPS Service" + } + }, + { + "name": "Microsoft.Devices/checkProvisioningServiceNameAvailability/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServives", + "operation": "Check If Provisioning Service name is available", + "description": "Check If Provisioning Service name is available" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Get Provisioning Service resource", + "description": "Get Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Create Provisioning Service resource", + "description": "Create Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Delete Provisioning Service resource", + "description": "Delete Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/skus/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Delete Provisioning Service resource", + "description": "Delete Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "get security related metadata", + "description": "get security related metadata" + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_patch.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_patch.json new file mode 100644 index 000000000000..77db5e3f58a6 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_patch.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "resourceName": "myHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "location": "East US", + "type": "Microsoft.Devices/IotHubs", + "IotHubTags": { + "tags": { + "foo": "bar" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": { + "foo": "bar" + }, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [], + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_quotametrics.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_quotametrics.json new file mode 100644 index 000000000000..0c8c1cb345a0 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_quotametrics.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TotalMessages", + "currentValue": 0, + "maxValue": 400000 + }, + { + "name": "TotalDeviceCount", + "currentValue": 0, + "maxValue": 500000 + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_routingendpointhealth.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_routingendpointhealth.json new file mode 100644 index 000000000000..f584060c5460 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_routingendpointhealth.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "endpointId": "id1", + "healthStatus": "healthy", + "lastSuccessfulSendAttemptTime": "2020-03-26T21:20:57Z", + "lastSendAttemptTime": "2020-03-26T21:24:57Z" + }, + { + "endpointId": "id2", + "healthStatus": "unknown" + }, + { + "endpointId": "id3", + "healthStatus": "unhealthy", + "lastKnownError": "NotFound", + "lastKnownErrorTime": "2020-03-26T21:24:57Z", + "lastSuccessfulSendAttemptTime": "2020-03-26T21:20:57Z", + "lastSendAttemptTime": "2020-03-26T21:24:57Z" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_stats.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_stats.json new file mode 100644 index 000000000000..1a7bcb918e7e --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_stats.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "totalDeviceCount": 0, + "enabledDeviceCount": 0, + "disabledDeviceCount": 0 + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_testallroutes.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_testallroutes.json new file mode 100644 index 000000000000..554b092ceb38 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_testallroutes.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "input": { + "routingSource": "DeviceMessages", + "message": { + "body": "Body of message", + "appProperties": { + "key1": "value1" + }, + "systemProperties": { + "key1": "value1" + } + } + } + }, + "responses": { + "200": { + "body": { + "routes": [ + { + "properties": { + "name": "Routeid", + "source": "DeviceMessages", + "endpointNames": [ + "id1" + ], + "isEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_testnewroute.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_testnewroute.json new file mode 100644 index 000000000000..d8e5b17845b1 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_testnewroute.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "input": { + "message": { + "body": "Body of message", + "appProperties": { + "key1": "value1" + }, + "systemProperties": { + "key1": "value1" + } + }, + "route": { + "name": "Routeid", + "source": "DeviceMessages", + "endpointNames": [ + "id1" + ], + "isEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "result": "false", + "details": { + "compilationErrors": [ + { + "message": "string response", + "severity": "error", + "location": { + "start": { + "line": 12, + "column": 12 + }, + "end": { + "line": 12, + "column": 24 + } + } + } + ] + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_updateprivateendpointconnection.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_updateprivateendpointconnection.json new file mode 100644 index 000000000000..c47df820ec93 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_updateprivateendpointconnection.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-15", + "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/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/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/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/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/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_usages.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_usages.json new file mode 100644 index 000000000000..496e1e89b41b --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/examples/iothub_usages.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-06-15", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages/freeHubCount", + "type": "/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages", + "unit": "count", + "currentValue": 1, + "limit": 1, + "name": { + "value": "FreeHubCount", + "localizedValue": "Free Hub Count" + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/iothub.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/iothub.json new file mode 100644 index 000000000000..634aea7c600b --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-06-15/iothub.json @@ -0,0 +1,4196 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-06-15", + "title": "iotHubClient", + "description": "Use this API to manage the IoT hubs in your Azure subscription.", + "x-ms-code-generation-settings": { + "header": "MICROSOFT_MIT_NO_VERSION" + } + }, + "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" + ], + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/iothub_operations.json" + } + }, + "operationId": "Operations_List", + "description": "Lists all of the available IoT Hub REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the non-security related metadata of an IoT hub", + "description": "Get the non-security related metadata of an IoT hub.", + "operationId": "IotHubResource_Get", + "x-ms-examples": { + "IotHubResource_Get": { + "$ref": "./examples/iothub_get.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 IoT hub. Security-related properties are set to null.", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "PUT" + ], + "summary": "Create or update the metadata of an IoT hub.", + "description": "Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub.", + "operationId": "IotHubResource_CreateOrUpdate", + "x-ms-examples": { + "IotHubResource_CreateOrUpdate": { + "$ref": "./examples/iothub_createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "iotHubDescription", + "in": "body", + "description": "The IoT hub metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub." + } + ], + "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/IotHubDescription" + } + }, + "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/IotHubDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "PATCH" + ], + "summary": "Update an existing IoT Hubs tags.", + "description": "Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method", + "x-ms-long-running-operation": true, + "operationId": "IotHubResource_Update", + "x-ms-examples": { + "IotHubResource_Update": { + "$ref": "./examples/iothub_patch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of iot hub to update." + }, + { + "name": "IotHubTags", + "in": "body", + "required": true, + "description": "Updated tag information to set into the iot hub instance.", + "schema": { + "$ref": "#/definitions/TagsResource" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Iot Hub was successfully updated", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "DELETE" + ], + "summary": "Delete an IoT hub", + "description": "Delete an IoT hub.", + "operationId": "IotHubResource_Delete", + "x-ms-examples": { + "IotHubResource_Delete": { + "$ref": "./examples/iothub_delete.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "202": { + "description": "The Iot Hub 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 IoT Hub service status directly, or query the operation resource.", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "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.", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "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 Iot hub 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 Iot hub metadata in the service.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get all the IoT hubs in a subscription", + "description": "Get all the IoT hubs in a subscription.", + "operationId": "IotHubResource_ListBySubscription", + "x-ms-examples": { + "IotHubResource_ListBySubscription": { + "$ref": "./examples/iothub_listbysubscription.json" + } + }, + "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 IoT hubs in the subscription.", + "schema": { + "$ref": "#/definitions/IotHubDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get all the IoT hubs in a resource group", + "description": "Get all the IoT hubs in a resource group.", + "operationId": "IotHubResource_ListByResourceGroup", + "x-ms-examples": { + "IotHubResource_ListByResourceGroup": { + "$ref": "./examples/iothub_listbyrg.json" + } + }, + "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 IoT hubs in the resource group.", + "schema": { + "$ref": "#/definitions/IotHubDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the statistics from an IoT hub", + "description": "Get the statistics from an IoT hub.", + "operationId": "IotHubResource_GetStats", + "x-ms-examples": { + "IotHubResource_GetStats": { + "$ref": "./examples/iothub_stats.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains JSON-serialized statistics from the identity registry in the IoT hub.", + "schema": { + "$ref": "#/definitions/RegistryStatistics" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the list of valid SKUs for an IoT hub", + "description": "Get the list of valid SKUs for an IoT hub.", + "operationId": "IotHubResource_GetValidSkus", + "x-ms-examples": { + "IotHubResource_GetValidSkus": { + "$ref": "./examples/iothub_getskus.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the valid SKUs for this IoT hub.", + "schema": { + "$ref": "#/definitions/IotHubSkuDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub", + "description": "Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.", + "operationId": "IotHubResource_ListEventHubConsumerGroups", + "x-ms-examples": { + "IotHubResource_ListEventHubConsumerGroups": { + "$ref": "./examples/iothub_listehgroups.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "eventHubEndpointName", + "in": "path", + "description": "The name of the Event Hub-compatible endpoint.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized list of the consumer groups in the Event Hub-compatible endpoint in this IoT hub", + "schema": { + "$ref": "#/definitions/EventHubConsumerGroupsListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub", + "description": "Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.", + "operationId": "IotHubResource_GetEventHubConsumerGroup", + "x-ms-examples": { + "IotHubResource_ListEventHubConsumerGroups": { + "$ref": "./examples/iothub_getconsumergroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "eventHubEndpointName", + "in": "path", + "description": "The name of the Event Hub-compatible endpoint in the IoT hub.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the consumer group to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized consumer group.", + "schema": { + "$ref": "#/definitions/EventHubConsumerGroupInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "PUT" + ], + "summary": "Add a consumer group to an Event Hub-compatible endpoint in an IoT hub", + "description": "Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.", + "operationId": "IotHubResource_CreateEventHubConsumerGroup", + "x-ms-examples": { + "IotHubResource_CreateEventHubConsumerGroup": { + "$ref": "./examples/iothub_createconsumergroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "eventHubEndpointName", + "in": "path", + "description": "The name of the Event Hub-compatible endpoint in the IoT hub.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the consumer group to add.", + "required": true, + "type": "string" + }, + { + "name": "consumerGroupBody", + "in": "body", + "description": "The consumer group to add.", + "required": true, + "schema": { + "$ref": "#/definitions/EventHubConsumerGroupBodyDescription" + } + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation.", + "schema": { + "$ref": "#/definitions/EventHubConsumerGroupInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "DELETE" + ], + "summary": "Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub", + "description": "Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.", + "operationId": "IotHubResource_DeleteEventHubConsumerGroup", + "x-ms-examples": { + "IotHubResource_DeleteEventHubConsumerGroup": { + "$ref": "./examples/iothub_deleteconsumergroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "eventHubEndpointName", + "in": "path", + "description": "The name of the Event Hub-compatible endpoint in the IoT hub.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the consumer group to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry", + "description": "Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.", + "operationId": "IotHubResource_ListJobs", + "x-ms-examples": { + "IotHubResource_ListJobs": { + "$ref": "./examples/iothub_listjobs.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The response contains a JSON-serialized array of all the jobs in the IoT hub.", + "schema": { + "$ref": "#/definitions/JobResponseListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry", + "description": "Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.", + "operationId": "IotHubResource_GetJob", + "x-ms-examples": { + "IotHubResource_GetJob": { + "$ref": "./examples/iothub_getjob.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "jobId", + "in": "path", + "description": "The job identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The response contains a JSON-serialized description of the job in the IoT hub.", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the quota metrics for an IoT hub", + "description": "Get the quota metrics for an IoT hub.", + "operationId": "IotHubResource_GetQuotaMetrics", + "x-ms-examples": { + "IotHubResource_GetQuotaMetrics": { + "$ref": "./examples/iothub_quotametrics.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The response contains a JSON-serialized array of the quota metrics for the IoT hub.", + "schema": { + "$ref": "#/definitions/IotHubQuotaMetricInfoListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routingEndpointsHealth": { + "get": { + "tags": [ + "GET" + ], + "operationId": "IotHubResource_GetEndpointHealth", + "summary": "Get the health for routing endpoints", + "description": "Get the health for routing endpoints.", + "x-ms-examples": { + "IotHubResource_GetEndpointHealth": { + "$ref": "./examples/iothub_routingendpointhealth.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "iotHubName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EndpointHealthDataListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability": { + "post": { + "tags": [ + "POST" + ], + "summary": "Check if an IoT hub name is available", + "description": "Check if an IoT hub name is available.", + "operationId": "IotHubResource_CheckNameAvailability", + "x-ms-examples": { + "IotHubResource_CheckNameAvailability": { + "$ref": "./examples/checkNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "operationInputs", + "in": "body", + "description": "Set the name parameter in the OperationInputs structure to the name of the IoT hub to check.", + "required": true, + "schema": { + "$ref": "#/definitions/OperationInputs" + } + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the IoT hub name is available. If the name is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/IotHubNameAvailabilityInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/usages": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the number of iot hubs in the subscription", + "description": "Get the number of free and paid iot hubs in the subscription", + "operationId": "ResourceProviderCommon_GetSubscriptionQuota", + "x-ms-examples": { + "ResourceProviderCommon_GetSubscriptionQuota": { + "$ref": "./examples/iothub_usages.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UserSubscriptionQuotaListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotHubResource_TestAllRoutes", + "summary": "Test all routes", + "description": "Test all routes configured in this Iot Hub", + "x-ms-examples": { + "IotHubResource_TestAllRoutes": { + "$ref": "./examples/iothub_testallroutes.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "input", + "description": "Input for testing all routes", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestAllRoutesInput" + } + }, + { + "name": "iotHubName", + "description": "IotHub to be tested", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "resource group which Iot Hub belongs to", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TestAllRoutesResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testnew": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotHubResource_TestRoute", + "summary": "Test the new route", + "description": "Test the new route for this Iot Hub", + "x-ms-examples": { + "IotHubResource_TestRoute": { + "$ref": "./examples/iothub_testnewroute.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "input", + "description": "Route that needs to be tested", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestRouteInput" + } + }, + { + "name": "iotHubName", + "description": "IotHub to be tested", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "resource group which Iot Hub belongs to", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TestRouteResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys": { + "post": { + "tags": [ + "POST" + ], + "summary": "Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security", + "description": "Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.", + "operationId": "IotHubResource_ListKeys", + "x-ms-examples": { + "IotHubResource_ListKeys": { + "$ref": "./examples/iothub_listkeys.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "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 IoT hub endpoints.", + "schema": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRuleListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys": { + "post": { + "tags": [ + "POST" + ], + "summary": "Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security", + "description": "Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.", + "operationId": "IotHubResource_GetKeysForKeyName", + "x-ms-examples": { + "IotHubResource_GetKeysForKeyName": { + "$ref": "./examples/iothub_getkey.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the shared access policy.", + "required": true, + "type": "string" + } + ], + "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 IoT hub endpoints.", + "schema": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices": { + "post": { + "tags": [ + "POST" + ], + "summary": "Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities", + "description": "Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.", + "operationId": "IotHubResource_ExportDevices", + "x-ms-examples": { + "IotHubResource_ExportDevices": { + "$ref": "./examples/iothub_exportdevices.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "exportDevicesParameters", + "in": "body", + "description": "The parameters that specify the export devices operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ExportDevicesRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/importDevices": { + "post": { + "tags": [ + "POST" + ], + "summary": "Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities", + "description": "Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.", + "operationId": "IotHubResource_ImportDevices", + "x-ms-examples": { + "IotHubResource_ImportDevices": { + "$ref": "./examples/iothub_importdevices.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "importDevicesParameters", + "in": "body", + "description": "The parameters that specify the import devices operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ImportDevicesRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates": { + "get": { + "tags": [ + "Certificates" + ], + "summary": "Get the certificate list.", + "description": "Returns the list of certificates.", + "operationId": "Certificates_ListByIotHub", + "x-ms-examples": { + "Certificates_ListByIotHub": { + "$ref": "./examples/iothub_listcertificates.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains all the certificate list.", + "schema": { + "$ref": "#/definitions/CertificateListDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}": { + "get": { + "tags": [ + "Certificates" + ], + "summary": "Get the certificate.", + "description": "Returns the certificate.", + "operationId": "Certificates_Get", + "x-ms-examples": { + "Certificates_Get": { + "$ref": "./examples/iothub_getcertificate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + } + ], + "responses": { + "200": { + "description": "The body contains the certificate.", + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Certificates" + ], + "summary": "Upload the certificate to the IoT hub.", + "description": "Adds new or replaces existing certificate.", + "operationId": "Certificates_CreateOrUpdate", + "x-ms-examples": { + "Certificates_CreateOrUpdate": { + "$ref": "./examples/iothub_certificatescreateorupdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + }, + { + "name": "certificateDescription", + "in": "body", + "description": "The certificate body.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the Certificate. Do not specify for creating a brand new certificate. Required to update an existing certificate." + } + ], + "responses": { + "201": { + "description": "If certificate didn't exist creation was successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + "200": { + "description": "If certificate already exist and update was successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Certificates" + ], + "summary": "Delete an X509 certificate.", + "description": "Deletes an existing X509 certificate or does nothing if it does not exist.", + "operationId": "Certificates_Delete", + "x-ms-examples": { + "Certificates_Delete": { + "$ref": "./examples/iothub_certificatesdelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the Certificate." + } + ], + "responses": { + "200": { + "description": "Certificate has been deleted." + }, + "204": { + "description": "Certificate does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/generateVerificationCode": { + "post": { + "tags": [ + "Certificates" + ], + "summary": "Generate verification code for proof of possession flow.", + "description": "Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate.", + "operationId": "Certificates_GenerateVerificationCode", + "x-ms-examples": { + "Certificates_GenerateVerificationCode": { + "$ref": "./examples/iothub_generateverificationcode.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the Certificate." + } + ], + "responses": { + "200": { + "description": "The body contains the certificate.", + "schema": { + "$ref": "#/definitions/CertificateWithNonceDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/verify": { + "post": { + "tags": [ + "Certificates" + ], + "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.", + "operationId": "Certificates_Verify", + "x-ms-examples": { + "Certificates_Verify": { + "$ref": "./examples/iothub_certverify.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + }, + { + "name": "certificateVerificationBody", + "in": "body", + "description": "The name of the certificate", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateVerificationDescription" + } + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the Certificate." + } + ], + "responses": { + "200": { + "description": "The body contains the certificate.", + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/failover": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotHub_ManualFailover", + "summary": "Manually initiate a failover for the IoT Hub to its secondary region", + "description": "Manually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover", + "x-ms-examples": { + "IotHub_ManualFailover": { + "$ref": "./examples/IotHub_ManualFailover.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "parameters": [ + { + "name": "iotHubName", + "description": "Name of the IoT hub to failover", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "failoverInput", + "description": "Region to failover to. Must be the Azure paired region. Get the value from the secondary location in the locations property. To learn more, see https://aka.ms/manualfailover/region", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FailoverInput" + } + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "Name of the resource group containing the IoT hub resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Long running manual failover operation for the IoT hub completed" + }, + "202": { + "description": "Manual failover initiated" + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "GET" + ], + "summary": "List private link resources", + "description": "List private link resources for the given IotHub", + "operationId": "PrivateLinkResources_List", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/iothub_listprivatelinkresources.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/iotHubs/{resourceName}/privateLinkResources/{groupId}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the specified private link resource", + "description": "Get the specified private link resource for the given IotHub", + "operationId": "PrivateLinkResources_Get", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/iothub_getprivatelinkresources.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/iotHubs/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "GET" + ], + "summary": "List private endpoint connections", + "description": "List private endpoint connection properties", + "operationId": "PrivateEndpointConnections_List", + "x-ms-examples": { + "PrivateEndpointConnections_List": { + "$ref": "./examples/iothub_listprivateendpointconnections.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/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get private endpoint connection", + "description": "Get private endpoint connection properties", + "operationId": "PrivateEndpointConnections_Get", + "x-ms-examples": { + "PrivateEndpointConnection_Get": { + "$ref": "./examples/iothub_getprivateendpointconnection.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": "Update private endpoint connection", + "description": "Update the status of a private endpoint connection with the specified name", + "operationId": "PrivateEndpointConnections_Update", + "x-ms-examples": { + "PrivateEndpointConnection_Update": { + "$ref": "./examples/iothub_updateprivateendpointconnection.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": "PrivateEndpointConnections_Delete", + "x-ms-examples": { + "PrivateEndpointConnection_Delete": { + "$ref": "./examples/iothub_deleteprivateendpointconnection.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": { + "CertificateVerificationDescription": { + "description": "The JSON-serialized leaf certificate", + "type": "object", + "properties": { + "certificate": { + "description": "base-64 representation of X509 certificate .cer file or just .pem file content.", + "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/CertificateDescription" + } + } + } + }, + "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" + } + } + }, + "CertificateDescription": { + "description": "The X509 Certificate.", + "type": "object", + "properties": { + "properties": { + "$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 + }, + "CertificateWithNonceDescription": { + "description": "The X509 Certificate.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CertificatePropertiesWithNonce" + }, + "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 + }, + "SharedAccessSignatureAuthorizationRule": { + "description": "The properties of an IoT hub shared access policy.", + "type": "object", + "properties": { + "keyName": { + "description": "The name of the shared access policy.", + "type": "string" + }, + "primaryKey": { + "description": "The primary key.", + "type": "string" + }, + "secondaryKey": { + "description": "The secondary key.", + "type": "string" + }, + "rights": { + "description": "The permissions assigned to the shared access policy.", + "enum": [ + "RegistryRead", + "RegistryWrite", + "ServiceConnect", + "DeviceConnect", + "RegistryRead, RegistryWrite", + "RegistryRead, ServiceConnect", + "RegistryRead, DeviceConnect", + "RegistryWrite, ServiceConnect", + "RegistryWrite, DeviceConnect", + "ServiceConnect, DeviceConnect", + "RegistryRead, RegistryWrite, ServiceConnect", + "RegistryRead, RegistryWrite, DeviceConnect", + "RegistryRead, ServiceConnect, DeviceConnect", + "RegistryWrite, ServiceConnect, DeviceConnect", + "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessRights", + "modelAsString": false + } + } + }, + "required": [ + "keyName", + "rights" + ] + }, + "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 create 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 + }, + "certificate": { + "description": "The certificate content", + "type": "string" + } + } + }, + "CertificatePropertiesWithNonce": { + "description": "The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.", + "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 create 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 + }, + "verificationCode": { + "description": "The certificate's verification code that will be used for proof of possession.", + "type": "string", + "readOnly": true + }, + "certificate": { + "description": "The certificate content", + "type": "string", + "readOnly": true + } + } + }, + "IotHubProperties": { + "description": "The properties of an IoT hub.", + "type": "object", + "properties": { + "authorizationPolicies": { + "description": "The shared access policies you can use to secure a connection to the IoT hub.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule" + } + }, + "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" + } + }, + "minTlsVersion": { + "type": "string", + "description": "Specifies the minimum TLS version to support for this hub. Can be set to \"1.2\" to have clients that use a TLS version below 1.2 to be rejected." + }, + "privateEndpointConnections": { + "description": "Private endpoint connections created on this IotHub", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "provisioningState": { + "description": "The provisioning state.", + "type": "string", + "readOnly": true + }, + "state": { + "description": "The hub state.", + "type": "string", + "readOnly": true + }, + "hostName": { + "description": "The name of the host.", + "type": "string", + "readOnly": true + }, + "eventHubEndpoints": { + "description": "The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/EventHubProperties" + } + }, + "routing": { + "$ref": "#/definitions/RoutingProperties" + }, + "storageEndpoints": { + "description": "The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StorageEndpointProperties" + } + }, + "messagingEndpoints": { + "description": "The messaging endpoint properties for the file upload notification queue.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MessagingEndpointProperties" + } + }, + "enableFileUploadNotifications": { + "description": "If True, file upload notifications are enabled.", + "type": "boolean" + }, + "cloudToDevice": { + "$ref": "#/definitions/CloudToDeviceProperties" + }, + "comments": { + "description": "IoT hub comments.", + "type": "string" + }, + "features": { + "description": "The capabilities and features enabled for the IoT hub.", + "enum": [ + "None", + "DeviceManagement" + ], + "type": "string", + "x-ms-enum": { + "name": "Capabilities", + "modelAsString": true + } + }, + "locations": { + "description": "Primary and secondary location for iot hub", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/IotHubLocationDescription" + } + } + } + }, + "IotHubSkuInfo": { + "description": "Information about the SKU of the IoT hub.", + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU.", + "enum": [ + "F1", + "S1", + "S2", + "S3", + "B1", + "B2", + "B3" + ], + "type": "string", + "x-ms-enum": { + "name": "IotHubSku", + "modelAsString": true + } + }, + "tier": { + "description": "The billing tier for the IoT hub.", + "enum": [ + "Free", + "Standard", + "Basic" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "IotHubSkuTier", + "modelAsString": false + } + }, + "capacity": { + "format": "int64", + "description": "The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.", + "type": "integer" + } + }, + "required": [ + "name" + ] + }, + "EventHubProperties": { + "description": "The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.", + "type": "object", + "properties": { + "retentionTimeInDays": { + "format": "int64", + "description": "The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages", + "type": "integer" + }, + "partitionCount": { + "format": "int32", + "description": "The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.", + "type": "integer" + }, + "partitionIds": { + "description": "The partition ids in the Event Hub-compatible endpoint.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "path": { + "description": "The Event Hub-compatible name.", + "type": "string", + "readOnly": true + }, + "endpoint": { + "description": "The Event Hub-compatible endpoint.", + "type": "string", + "readOnly": true + } + } + }, + "StorageEndpointProperties": { + "description": "The properties of the Azure Storage endpoint for file upload.", + "type": "object", + "properties": { + "sasTtlAsIso8601": { + "description": "The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.", + "type": "string", + "format": "duration" + }, + "connectionString": { + "description": "The connection string for the Azure Storage account to which files are uploaded.", + "type": "string" + }, + "containerName": { + "description": "The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.", + "type": "string" + }, + "authenticationType": { + "description": "Specifies authentication type being used for connecting to the storage account.", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + } + }, + "required": [ + "connectionString", + "containerName" + ] + }, + "MessagingEndpointProperties": { + "description": "The properties of the messaging endpoints used by this IoT hub.", + "type": "object", + "properties": { + "lockDurationAsIso8601": { + "description": "The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.", + "type": "string", + "format": "duration" + }, + "ttlAsIso8601": { + "description": "The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.", + "type": "string", + "format": "duration" + }, + "maxDeliveryCount": { + "description": "The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.", + "format": "int32", + "type": "integer", + "minimum": 1, + "maximum": 100 + } + } + }, + "CloudToDeviceProperties": { + "description": "The IoT hub cloud-to-device messaging properties.", + "type": "object", + "properties": { + "maxDeliveryCount": { + "description": "The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "format": "int32", + "type": "integer", + "minimum": 1, + "maximum": 100 + }, + "defaultTtlAsIso8601": { + "description": "The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "type": "string", + "format": "duration" + }, + "feedback": { + "$ref": "#/definitions/FeedbackProperties" + } + } + }, + "IpFilterRule": { + "description": "The IP filter rules for the IoT hub.", + "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" + } + }, + "required": [ + "filterName", + "action", + "ipMask" + ] + }, + "PrivateLinkResources": { + "description": "The available private link resources for an IotHub", + "type": "object", + "properties": { + "value": { + "description": "The list of available private link resources for an IotHub", + "type": "array", + "items": { + "$ref": "#/definitions/GroupIdInformation" + } + } + } + }, + "GroupIdInformation": { + "description": "The group information for creating a private endpoint on an IotHub", + "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": { + "$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 an IotHub", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "PrivateEndpointConnection": { + "description": "The private endpoint connection of an IotHub", + "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": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + } + }, + "required": [ + "properties" + ] + }, + "PrivateEndpointConnectionProperties": { + "description": "The properties of a private endpoint connection", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "$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" + ] + }, + "FeedbackProperties": { + "description": "The properties of the feedback queue for cloud-to-device messages.", + "type": "object", + "properties": { + "lockDurationAsIso8601": { + "description": "The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "type": "string", + "format": "duration" + }, + "ttlAsIso8601": { + "description": "The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "type": "string", + "format": "duration" + }, + "maxDeliveryCount": { + "description": "The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "format": "int32", + "type": "integer", + "minimum": 1, + "maximum": 100 + } + } + }, + "RoutingProperties": { + "description": "The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging", + "type": "object", + "properties": { + "endpoints": { + "$ref": "#/definitions/RoutingEndpoints" + }, + "routes": { + "description": "The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.", + "type": "array", + "items": { + "$ref": "#/definitions/RouteProperties" + } + }, + "fallbackRoute": { + "description": "The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.", + "$ref": "#/definitions/FallbackRouteProperties" + }, + "enrichments": { + "description": "The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid", + "type": "array", + "items": { + "$ref": "#/definitions/EnrichmentProperties" + } + } + } + }, + "RoutingEndpoints": { + "description": "The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.", + "type": "object", + "properties": { + "serviceBusQueues": { + "description": "The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.", + "type": "array", + "items": { + "$ref": "#/definitions/RoutingServiceBusQueueEndpointProperties" + } + }, + "serviceBusTopics": { + "description": "The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.", + "type": "array", + "items": { + "$ref": "#/definitions/RoutingServiceBusTopicEndpointProperties" + } + }, + "eventHubs": { + "description": "The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/RoutingEventHubProperties" + } + }, + "storageContainers": { + "description": "The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.", + "type": "array", + "items": { + "$ref": "#/definitions/RoutingStorageContainerProperties" + } + } + } + }, + "RoutingServiceBusQueueEndpointProperties": { + "description": "The properties related to service bus queue endpoint types.", + "type": "object", + "properties": { + "id": { + "description": "Id of the service bus queue endpoint", + "type": "string" + }, + "connectionString": { + "description": "The connection string of the service bus queue endpoint.", + "type": "string" + }, + "endpointUri": { + "description": "The url of the service bus queue endpoint. It must include the protocol sb://", + "type": "string" + }, + "entityPath": { + "description": "Queue name on the service bus namespace", + "type": "string" + }, + "authenticationType": { + "description": "Method used to authenticate against the service bus queue endpoint", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true + } + }, + "name": { + "description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "subscriptionId": { + "description": "The subscription identifier of the service bus queue endpoint.", + "type": "string" + }, + "resourceGroup": { + "description": "The name of the resource group of the service bus queue endpoint.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "RoutingServiceBusTopicEndpointProperties": { + "description": "The properties related to service bus topic endpoint types.", + "type": "object", + "properties": { + "id": { + "description": "Id of the service bus topic endpoint", + "type": "string" + }, + "connectionString": { + "description": "The connection string of the service bus topic endpoint.", + "type": "string" + }, + "endpointUri": { + "description": "The url of the service bus topic endpoint. It must include the protocol sb://", + "type": "string" + }, + "entityPath": { + "description": "Queue name on the service bus topic", + "type": "string" + }, + "authenticationType": { + "description": "Method used to authenticate against the service bus topic endpoint", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true + } + }, + "name": { + "description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "subscriptionId": { + "description": "The subscription identifier of the service bus topic endpoint.", + "type": "string" + }, + "resourceGroup": { + "description": "The name of the resource group of the service bus topic endpoint.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "RoutingEventHubProperties": { + "description": "The properties related to an event hub endpoint.", + "type": "object", + "properties": { + "id": { + "description": "Id of the event hub endpoint", + "type": "string" + }, + "connectionString": { + "description": "The connection string of the event hub endpoint. ", + "type": "string" + }, + "endpointUri": { + "description": "The url of the event hub endpoint. It must include the protocol sb://", + "type": "string" + }, + "entityPath": { + "description": "Event hub name on the event hub namespace", + "type": "string" + }, + "authenticationType": { + "description": "Method used to authenticate against the event hub endpoint", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true + } + }, + "name": { + "description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "subscriptionId": { + "description": "The subscription identifier of the event hub endpoint.", + "type": "string" + }, + "resourceGroup": { + "description": "The name of the resource group of the event hub endpoint.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "RoutingStorageContainerProperties": { + "description": "The properties related to a storage container endpoint.", + "type": "object", + "properties": { + "id": { + "description": "Id of the storage container endpoint", + "type": "string" + }, + "connectionString": { + "description": "The connection string of the storage account.", + "type": "string" + }, + "endpointUri": { + "description": "The url of the storage endpoint. It must include the protocol https://", + "type": "string" + }, + "authenticationType": { + "description": "Method used to authenticate against the storage endpoint", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true + } + }, + "name": { + "description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "subscriptionId": { + "description": "The subscription identifier of the storage account.", + "type": "string" + }, + "resourceGroup": { + "description": "The name of the resource group of the storage account.", + "type": "string" + }, + "containerName": { + "description": "The name of storage container in the storage account.", + "type": "string" + }, + "fileNameFormat": { + "description": "File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.", + "type": "string" + }, + "batchFrequencyInSeconds": { + "description": "Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.", + "format": "int32", + "type": "integer", + "maximum": 720, + "minimum": 60 + }, + "maxChunkSizeInBytes": { + "description": "Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).", + "format": "int32", + "type": "integer", + "maximum": 524288000, + "minimum": 10485760 + }, + "encoding": { + "description": "Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'.", + "type": "string", + "enum": [ + "Avro", + "AvroDeflate", + "JSON" + ] + } + }, + "required": [ + "name", + "containerName" + ] + }, + "RouteProperties": { + "description": "The properties of a routing rule that your IoT hub uses to route messages to endpoints.", + "type": "object", + "properties": { + "name": { + "description": "The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "source": { + "description": "The source that the routing rule is to be applied to, such as DeviceMessages.", + "enum": [ + "Invalid", + "DeviceMessages", + "TwinChangeEvents", + "DeviceLifecycleEvents", + "DeviceJobLifecycleEvents" + ], + "type": "string", + "x-ms-enum": { + "name": "RoutingSource", + "modelAsString": true + } + }, + "condition": { + "description": "The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language", + "type": "string" + }, + "endpointNames": { + "description": "The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.", + "minItems": 1, + "maxItems": 1, + "type": "array", + "items": { + "type": "string" + } + }, + "isEnabled": { + "description": "Used to specify whether a route is enabled.", + "type": "boolean" + } + }, + "required": [ + "name", + "endpointNames", + "source", + "isEnabled" + ] + }, + "FallbackRouteProperties": { + "description": "The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.", + "type": "object", + "properties": { + "name": { + "description": "The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.", + "type": "string" + }, + "source": { + "description": "The source to which the routing rule is to be applied to. For example, DeviceMessages", + "enum": [ + "DeviceMessages" + ], + "type": "string", + "x-ms-enum": { + "name": "RoutingSource", + "modelAsString": true + } + }, + "condition": { + "description": "The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language", + "type": "string" + }, + "endpointNames": { + "description": "The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.", + "minItems": 1, + "maxItems": 1, + "type": "array", + "items": { + "type": "string" + } + }, + "isEnabled": { + "description": "Used to specify whether the fallback route is enabled.", + "type": "boolean" + } + }, + "required": [ + "endpointNames", + "source", + "isEnabled" + ] + }, + "EnrichmentProperties": { + "description": "The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.", + "type": "object", + "properties": { + "key": { + "description": "The key or name for the enrichment property.", + "type": "string" + }, + "value": { + "description": "The value for the enrichment property.", + "type": "string" + }, + "endpointNames": { + "description": "The list of endpoints for which the enrichment is applied to the message.", + "minItems": 1, + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "key", + "value", + "endpointNames" + ] + }, + "IotHubDescription": { + "description": "The description of the IoT hub.", + "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": "IotHub properties", + "$ref": "#/definitions/IotHubProperties" + }, + "sku": { + "description": "IotHub SKU info", + "$ref": "#/definitions/IotHubSkuInfo" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "sku" + ] + }, + "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" + ] + }, + "SharedAccessSignatureAuthorizationRuleListResult": { + "description": "The list of shared access policies with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The list of shared access policies.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "OperationListResult": { + "description": "Result of the request to list IoT Hub operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of IoT Hub 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": "IoT Hub 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: IotHubs" + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Name of the operation" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Description 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 + } + } + }, + "IotHubQuotaMetricInfoListResult": { + "description": "The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of quota metrics objects.", + "type": "array", + "items": { + "$ref": "#/definitions/IotHubQuotaMetricInfo" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "EndpointHealthDataListResult": { + "description": "The JSON-serialized array of EndpointHealthData objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "JSON-serialized array of Endpoint health data", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointHealthData" + } + }, + "nextLink": { + "description": "Link to more results", + "type": "string", + "readOnly": true + } + } + }, + "EndpointHealthData": { + "description": "The health data for an endpoint", + "type": "object", + "properties": { + "endpointId": { + "description": "Id of the endpoint", + "type": "string" + }, + "healthStatus": { + "description": "Health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint", + "enum": [ + "unknown", + "healthy", + "degraded", + "unhealthy", + "dead" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointHealthStatus", + "modelAsString": true + } + }, + "lastKnownError": { + "description": "Last error obtained when a message failed to be delivered to iot hub", + "type": "string" + }, + "lastKnownErrorTime": { + "description": "Time at which the last known error occurred", + "type": "string", + "format": "date-time-rfc1123" + }, + "lastSuccessfulSendAttemptTime": { + "description": "Last time iot hub successfully sent a message to the endpoint", + "type": "string", + "format": "date-time-rfc1123" + }, + "lastSendAttemptTime": { + "description": "Last time iot hub tried to send a message to the endpoint", + "type": "string", + "format": "date-time-rfc1123" + } + } + }, + "RegistryStatistics": { + "description": "Identity registry statistics.", + "type": "object", + "properties": { + "totalDeviceCount": { + "format": "int64", + "description": "The total count of devices in the identity registry.", + "type": "integer", + "readOnly": true + }, + "enabledDeviceCount": { + "format": "int64", + "description": "The count of enabled devices in the identity registry.", + "type": "integer", + "readOnly": true + }, + "disabledDeviceCount": { + "format": "int64", + "description": "The count of disabled devices in the identity registry.", + "type": "integer", + "readOnly": true + } + } + }, + "JobResponseListResult": { + "description": "The JSON-serialized array of JobResponse objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of JobResponse objects.", + "type": "array", + "items": { + "$ref": "#/definitions/JobResponse" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubSkuDescription": { + "description": "SKU properties.", + "type": "object", + "properties": { + "resourceType": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "sku": { + "description": "The type of the resource.", + "$ref": "#/definitions/IotHubSkuInfo" + }, + "capacity": { + "description": "IotHub capacity", + "$ref": "#/definitions/IotHubCapacity" + } + }, + "required": [ + "sku", + "capacity" + ] + }, + "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 an IoT Hub instance." + }, + "IotHubCapacity": { + "description": "IoT Hub capacity information.", + "type": "object", + "properties": { + "minimum": { + "format": "int64", + "description": "The minimum number of units.", + "type": "integer", + "minimum": 1, + "maximum": 1, + "readOnly": true + }, + "maximum": { + "format": "int64", + "description": "The maximum number of units.", + "type": "integer", + "readOnly": true + }, + "default": { + "format": "int64", + "description": "The default number of units.", + "type": "integer", + "readOnly": true + }, + "scaleType": { + "description": "The type of the scaling enabled.", + "enum": [ + "Automatic", + "Manual", + "None" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "IotHubScaleType", + "modelAsString": false + } + } + } + }, + "EventHubConsumerGroupsListResult": { + "description": "The JSON-serialized array of Event Hub-compatible consumer group names with a next link.", + "type": "object", + "properties": { + "value": { + "description": "List of consumer groups objects", + "type": "array", + "items": { + "$ref": "#/definitions/EventHubConsumerGroupInfo" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "EventHubConsumerGroupBodyDescription": { + "description": "The EventHub consumer group.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EventHubConsumerGroupName" + } + } + }, + "EventHubConsumerGroupName": { + "description": "The EventHub consumer group name.", + "type": "object", + "properties": { + "name": { + "description": "EventHub consumer group name", + "type": "string" + } + } + }, + "EventHubConsumerGroupInfo": { + "description": "The properties of the EventHubConsumerGroupInfo object.", + "x-ms-azure-resource": true, + "type": "object", + "properties": { + "properties": { + "description": "The tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "id": { + "description": "The Event Hub-compatible consumer group identifier.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Event Hub-compatible consumer group name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "the resource type.", + "type": "string", + "readOnly": true + }, + "etag": { + "description": "The etag.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubSkuDescriptionListResult": { + "description": "The JSON-serialized array of IotHubSkuDescription objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of IotHubSkuDescription.", + "type": "array", + "items": { + "$ref": "#/definitions/IotHubSkuDescription" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "JobResponse": { + "description": "The properties of the Job Response object.", + "type": "object", + "properties": { + "jobId": { + "description": "The job identifier.", + "type": "string", + "readOnly": true + }, + "startTimeUtc": { + "format": "date-time-rfc1123", + "description": "The start time of the job.", + "type": "string", + "readOnly": true + }, + "endTimeUtc": { + "format": "date-time-rfc1123", + "description": "The time the job stopped processing.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the job.", + "enum": [ + "unknown", + "export", + "import", + "backup", + "readDeviceProperties", + "writeDeviceProperties", + "updateDeviceConfiguration", + "rebootDevice", + "factoryResetDevice", + "firmwareUpdate" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobType", + "modelAsString": true + } + }, + "status": { + "description": "The status of the job.", + "enum": [ + "unknown", + "enqueued", + "running", + "completed", + "failed", + "cancelled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": false + } + }, + "failureReason": { + "description": "If status == failed, this string containing the reason for the failure.", + "type": "string", + "readOnly": true + }, + "statusMessage": { + "description": "The status message for the job.", + "type": "string", + "readOnly": true + }, + "parentJobId": { + "description": "The job identifier of the parent job, if any.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubDescriptionListResult": { + "description": "The JSON-serialized array of IotHubDescription objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of IotHubDescription objects.", + "type": "array", + "items": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubQuotaMetricInfo": { + "description": "Quota metrics properties.", + "type": "object", + "properties": { + "name": { + "description": "The name of the quota metric.", + "type": "string", + "readOnly": true + }, + "currentValue": { + "format": "int64", + "description": "The current value for the quota metric.", + "type": "integer", + "readOnly": true + }, + "maxValue": { + "format": "int64", + "description": "The maximum value of the quota metric.", + "type": "integer", + "readOnly": true + } + } + }, + "OperationInputs": { + "description": "Input values.", + "type": "object", + "properties": { + "name": { + "description": "The name of the IoT hub to check.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "IotHubNameAvailabilityInfo": { + "description": "The properties indicating whether a given IoT hub 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": "IotHubNameUnavailabilityReason", + "modelAsString": false + } + }, + "message": { + "description": "The detailed reason message.", + "type": "string" + } + } + }, + "UserSubscriptionQuotaListResult": { + "type": "object", + "description": "Json-serialized array of User subscription quota response", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UserSubscriptionQuota" + } + }, + "nextLink": { + "type": "string", + "readOnly": true + } + } + }, + "UserSubscriptionQuota": { + "description": "User subscription quota response", + "type": "object", + "properties": { + "id": { + "description": "IotHub type id", + "type": "string" + }, + "type": { + "description": "Response type", + "type": "string" + }, + "unit": { + "description": "Unit of IotHub type", + "type": "string" + }, + "currentValue": { + "description": "Current number of IotHub type", + "format": "int32", + "type": "integer" + }, + "limit": { + "description": "Numerical limit on IotHub type", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "IotHub type", + "$ref": "#/definitions/Name" + } + } + }, + "Name": { + "description": "Name of Iot Hub type", + "type": "object", + "properties": { + "value": { + "description": "IotHub type", + "type": "string" + }, + "localizedValue": { + "description": "Localized value of name", + "type": "string" + } + } + }, + "TestAllRoutesInput": { + "description": "Input for testing all routes", + "type": "object", + "properties": { + "routingSource": { + "description": "Routing source", + "enum": [ + "Invalid", + "DeviceMessages", + "TwinChangeEvents", + "DeviceLifecycleEvents", + "DeviceJobLifecycleEvents" + ], + "type": "string", + "x-ms-enum": { + "name": "RoutingSource", + "modelAsString": true + } + }, + "message": { + "description": "Routing message", + "$ref": "#/definitions/RoutingMessage" + }, + "twin": { + "description": "Routing Twin Reference", + "$ref": "#/definitions/RoutingTwin" + } + } + }, + "RoutingTwin": { + "description": "Twin reference input parameter. This is an optional parameter", + "type": "object", + "properties": { + "tags": { + "description": "Twin Tags", + "type": "object" + }, + "properties": { + "properties": { + "desired": { + "description": "Twin desired properties", + "type": "object" + }, + "reported": { + "description": "Twin desired properties", + "type": "object" + } + } + } + } + }, + "RoutingMessage": { + "description": "Routing message", + "type": "object", + "properties": { + "body": { + "description": "Body of routing message", + "type": "string" + }, + "appProperties": { + "description": "App properties", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "systemProperties": { + "description": "System properties", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TestAllRoutesResult": { + "description": "Result of testing all routes", + "type": "object", + "properties": { + "routes": { + "description": "JSON-serialized array of matched routes", + "type": "array", + "items": { + "$ref": "#/definitions/MatchedRoute" + } + } + } + }, + "MatchedRoute": { + "description": "Routes that matched", + "type": "object", + "properties": { + "properties": { + "description": "Properties of routes that matched", + "$ref": "#/definitions/RouteProperties" + } + } + }, + "TestRouteInput": { + "required": [ + "route" + ], + "description": "Input for testing route", + "type": "object", + "properties": { + "message": { + "description": "Routing message", + "$ref": "#/definitions/RoutingMessage" + }, + "route": { + "description": "Route properties", + "$ref": "#/definitions/RouteProperties" + }, + "twin": { + "description": "Routing Twin Reference", + "$ref": "#/definitions/RoutingTwin" + } + } + }, + "TestRouteResult": { + "description": "Result of testing one route", + "type": "object", + "properties": { + "result": { + "description": "Result of testing route", + "enum": [ + "undefined", + "false", + "true" + ], + "type": "string", + "x-ms-enum": { + "name": "TestResultStatus", + "modelAsString": true + } + }, + "details": { + "description": "Detailed result of testing route", + "$ref": "#/definitions/TestRouteResultDetails" + } + } + }, + "TestRouteResultDetails": { + "description": "Detailed result of testing a route", + "type": "object", + "properties": { + "compilationErrors": { + "description": "JSON-serialized list of route compilation errors", + "type": "array", + "items": { + "$ref": "#/definitions/RouteCompilationError" + } + } + } + }, + "RouteCompilationError": { + "description": "Compilation error when evaluating route", + "type": "object", + "properties": { + "message": { + "description": "Route error message", + "type": "string" + }, + "severity": { + "description": "Severity of the route error", + "enum": [ + "error", + "warning" + ], + "type": "string", + "x-ms-enum": { + "name": "RouteErrorSeverity", + "modelAsString": true + } + }, + "location": { + "description": "Location where the route error happened", + "$ref": "#/definitions/RouteErrorRange" + } + } + }, + "RouteErrorRange": { + "description": "Range of route errors", + "type": "object", + "properties": { + "start": { + "description": "Start where the route error happened", + "$ref": "#/definitions/RouteErrorPosition" + }, + "end": { + "description": "End where the route error happened", + "$ref": "#/definitions/RouteErrorPosition" + } + } + }, + "RouteErrorPosition": { + "description": "Position where the route error happened", + "type": "object", + "properties": { + "line": { + "description": "Line where the route error happened", + "format": "int32", + "type": "integer" + }, + "column": { + "description": "Column where the route error happened", + "format": "int32", + "type": "integer" + } + } + }, + "ExportDevicesRequest": { + "description": "Use to provide parameters when requesting an export of all devices in the IoT hub.", + "type": "object", + "properties": { + "exportBlobContainerUri": { + "description": "The export blob container URI.", + "type": "string" + }, + "excludeKeys": { + "description": "The value indicating whether keys should be excluded during export.", + "type": "boolean" + }, + "exportBlobName": { + "description": "The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub.", + "type": "string" + }, + "authenticationType": { + "description": "Specifies authentication type being used for connecting to the storage account.", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + } + }, + "required": [ + "exportBlobContainerUri", + "excludeKeys" + ] + }, + "ImportDevicesRequest": { + "description": "Use to provide parameters when requesting an import of all devices in the hub.", + "type": "object", + "properties": { + "inputBlobContainerUri": { + "description": "The input blob container URI.", + "type": "string" + }, + "outputBlobContainerUri": { + "description": "The output blob container URI.", + "type": "string" + }, + "inputBlobName": { + "description": "The blob name to be used when importing from the provided input blob container.", + "type": "string" + }, + "outputBlobName": { + "description": "The blob name to use for storing the status of the import job.", + "type": "string" + }, + "authenticationType": { + "description": "Specifies authentication type being used for connecting to the storage account.", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + } + }, + "required": [ + "inputBlobContainerUri", + "outputBlobContainerUri" + ] + }, + "FailoverInput": { + "description": "Use to provide failover region when requesting manual Failover for a hub.", + "type": "object", + "properties": { + "failoverRegion": { + "description": "Region the hub will be failed over to", + "type": "string" + } + }, + "required": [ + "failoverRegion" + ] + }, + "IotHubLocationDescription": { + "description": "Public representation of one of the locations where a resource is provisioned.", + "type": "object", + "properties": { + "location": { + "description": "The name of the Azure region", + "type": "string" + }, + "role": { + "description": "The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to.", + "enum": [ + "primary", + "secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "IotHubReplicaRoleType", + "modelAsString": true + } + } + } + } + }, + "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 IoT hub.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the IoT hub.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "certificateName": { + "name": "certificateName", + "in": "path", + "description": "The name of the certificate", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$", + "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/iothub/resource-manager/readme.md b/specification/iothub/resource-manager/readme.md index f0842a0bf742..d359d6a349ce 100644 --- a/specification/iothub/resource-manager/readme.md +++ b/specification/iothub/resource-manager/readme.md @@ -26,18 +26,27 @@ These are the global settings for the IotHub API. ``` yaml openapi-type: arm -tag: package-2020-04 +tag: package-2020-06 ``` +### Tag: package-2020-06 + +These settings apply only when `--tag=package-2020-06` is specified on the command line. + +```yaml $(tag) == 'package-2020-06' +input-file: + - Microsoft.Devices/stable/2020-06-15/iothub.json +``` ### Tag: package-2020-04 These settings apply only when `--tag=package-2020-04` is specified on the command line. -```yaml $(tag) == 'package-2020-04' +``` yaml $(tag) == 'package-2020-04' input-file: - Microsoft.Devices/stable/2020-04-01/iothub.json ``` + ### Tag: package-2020-03 These settings apply only when `--tag=package-2020-03` is specified on the command line. From 4170e39afbf7c16807150ec43ae6baeb2f272daf Mon Sep 17 00:00:00 2001 From: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com> Date: Sun, 2 Aug 2020 21:10:03 +0800 Subject: [PATCH 20/29] resource-resource-2019-03-01-python-config (#10314) --- .../resources/resource-manager/readme.python.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/specification/resources/resource-manager/readme.python.md b/specification/resources/resource-manager/readme.python.md index 6371fe633fa0..a280776e0d1a 100644 --- a/specification/resources/resource-manager/readme.python.md +++ b/specification/resources/resource-manager/readme.python.md @@ -424,6 +424,19 @@ python: output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/resources/v2019_05_01 ``` +### Tag: package-resources-2019-03 and python + +These settings apply only when `--tag=package-resources-2019-03 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-resources-2019-03' +namespace: azure.mgmt.resource.resources.v2019_03_01 +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/resources/v2019_03_01 +python: + namespace: azure.mgmt.resource.resources.v2019_03_01 + output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/resources/v2019_03_01 +``` + ### Tag: package-resources-2018-05 and python These settings apply only when `--tag=package-resources-2018-05 --python` is specified on the command line. From b7a061c84aaa4e8b278ff5aa447f91ad735c7929 Mon Sep 17 00:00:00 2001 From: navysingla <47647464+navysingla@users.noreply.github.com> Date: Sun, 2 Aug 2020 18:49:45 -0700 Subject: [PATCH 21/29] Alias Put Subscription API (#10205) * Alias Put API * Update subscriptions.json * Added List API * Feedback update * Update subscriptions.json * updated * Update subscriptions.json * Update deleteAlias.json * Update subscriptions.json * Update subscriptions.json --- .../examples/createAlias.json | 35 +++ .../examples/deleteAlias.json | 10 + .../2019-10-01-preview/examples/getAlias.json | 18 ++ .../examples/listAlias.json | 22 ++ .../2019-10-01-preview/subscriptions.json | 268 ++++++++++++++++++ 5 files changed, 353 insertions(+) create mode 100644 specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/createAlias.json create mode 100644 specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/deleteAlias.json create mode 100644 specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/getAlias.json create mode 100644 specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/listAlias.json diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/createAlias.json b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/createAlias.json new file mode 100644 index 000000000000..2aa968771e12 --- /dev/null +++ b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/createAlias.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "aliasName": "aliasForNewSub", + "api-version": "2019-10-01-preview", + "body": { + "properties": { + "displayName": "Contoso MCA subscription", + "billingScope": "/providers/Microsoft.Billing/billingAccounts/e879cf0f-2b4d-5431-109a-f72fc9868693:024cabf4-7321-4cf9-be59-df0c77ca51de_2019-05-31/billingProfiles/PE2Q-NOIT-BG7-TGB/invoiceSections/MTT4-OBS7-PJA-TGB", + "workloadType": "Production" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Subscription/aliases/aliasForNewSub", + "name": "aliasForNewSub", + "type": "Microsoft.Subscription/aliases", + "properties": { + "subscriptionId": "subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05" + } + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Subscription/aliases/aliasForNewSub", + "name": "aliasForNewSub", + "type": "Microsoft.Subscription/aliases", + "properties": { + "subscriptionId": "subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05" + } + } + } + } +} diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/deleteAlias.json b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/deleteAlias.json new file mode 100644 index 000000000000..8663c11a8528 --- /dev/null +++ b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/deleteAlias.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "aliasName": "aliasForNewSub", + "api-version": "2019-10-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/getAlias.json b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/getAlias.json new file mode 100644 index 000000000000..d36ebffa17b8 --- /dev/null +++ b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/getAlias.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "aliasName": "aliasForNewSub", + "api-version": "2019-10-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Subscription/aliases/aliasForNewSub", + "name": "aliasForNewSub", + "type": "Microsoft.Subscription/aliases", + "properties": { + "subscriptionId": "subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05" + } + } + } + } +} diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/listAlias.json b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/listAlias.json new file mode 100644 index 000000000000..8108ceb5ec9b --- /dev/null +++ b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/examples/listAlias.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Subscription/aliases/aliasForNewSub", + "name": "aliasForNewSub", + "type": "Microsoft.Subscription/aliases", + "properties": { + "subscriptionId": "subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json index 8605058478c8..19d2b3b1e662 100644 --- a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json +++ b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2019-10-01-preview/subscriptions.json @@ -392,6 +392,146 @@ } ] } + }, + "/providers/Microsoft.Subscription/aliases/{aliasName}": { + "put": { + "description": "Create Alias Subscription.", + "operationId": "Subscription_CreateAlias", + "x-ms-examples": { + "CreateAlias": { + "$ref": "./examples/createAlias.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "200": { + "description": "Normal response for a successful query.", + "schema": { + "$ref": "#/definitions/PutAliasResponse" + } + }, + "201": { + "description": "Accepted. Subscription creation is in progress.", + "schema": { + "$ref": "#/definitions/PutAliasResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/aliasNameParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PutAliasRequest" + } + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ] + }, + "get": { + "description": "Get Alias Subscription.", + "operationId": "Subscription_GetAlias", + "x-ms-examples": { + "GetAlias": { + "$ref": "./examples/getAlias.json" + } + }, + "responses": { + "200": { + "description": "Subscription details.", + "schema": { + "$ref": "#/definitions/PutAliasResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/aliasNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ] + }, + "delete": { + "description": "Delete Alias.", + "operationId": "Subscription_DeleteAlias", + "x-ms-examples": { + "DeleteAlias": { + "$ref": "./examples/deleteAlias.json" + } + }, + "responses": { + "200": { + "description": "Deleted the alias" + }, + "204": { + "description": "Alias does not exist" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/aliasNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ] + } + }, + "/providers/Microsoft.Subscription/aliases": { + "get": { + "description": "Get Alias Subscription.", + "operationId": "Subscription_ListAlias", + "x-ms-examples": { + "GetAlias": { + "$ref": "./examples/listAlias.json" + } + }, + "responses": { + "200": { + "description": "Subscription details.", + "schema": { + "$ref": "#/definitions/PutAliasListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ] + } } }, "definitions": { @@ -409,6 +549,16 @@ } } }, + "ErrorResponseBody": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/ErrorResponse" + } + } + }, "CanceledSubscriptionId": { "description": "The ID of the canceled subscription", "properties": { @@ -608,6 +758,116 @@ "type": "string" } } + }, + "PutAliasRequest": { + "description": "The parameters required to create a new subscription.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PutAliasRequestProperties", + "description": "Put alias request properties." + } + } + }, + "PutAliasRequestProperties": { + "description": "Put subscription properties.", + "required": [ + "displayName", + "workloadType", + "billingScope" + ], + "properties": { + "displayName": { + "description": "The friendly name of the subscription.", + "type": "string" + }, + "workloadType": { + "description": "The workload type of the subscription. It can be either Production or DevTest.", + "type": "string", + "x-ms-enum": { + "name": "workloadType", + "modelAsString": true + }, + "enum": [ + "Production", + "DevTest" + ] + }, + "billingScope": { + "description": "Determines whether subscription is fieldLed, partnerLed or LegacyEA", + "type": "string" + }, + "subscriptionId": { + "description": "This parameter can be used to create alias for existing subscription Id", + "type": "string" + } + } + }, + "PutAliasResponse": { + "description": "Subscription Information with the alias.", + "properties": { + "id": { + "description": "Fully qualified ID for the alias resource.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Alias ID.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type, Microsoft.Subscription/aliases.", + "readOnly": true, + "type": "string" + }, + "properties": { + "$ref": "#/definitions/PutAliasResponseProperties", + "description": "Put Alias response properties." + } + }, + "x-ms-azure-resource": true + }, + "PutAliasResponseProperties": { + "description": "Put subscription creation result properties.", + "properties": { + "subscriptionId": { + "description": "Newly created subscription Id.", + "readOnly": true, + "type": "string" + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the resource.", + "enum": [ + "Accepted", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + } + }, + "PutAliasListResult": { + "description": "The list of aliases.", + "properties": { + "value": { + "description": "The list of alias.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PutAliasResponse" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } } }, "parameters": { @@ -635,6 +895,14 @@ "schema": { "$ref": "#/definitions/SubscriptionName" } + }, + "aliasNameParameter": { + "name": "aliasName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "Alias Name" } }, "security": [ From 9c0ab5508daf0b66f08df14d1d921113baf8ee80 Mon Sep 17 00:00:00 2001 From: Arcturus Date: Mon, 3 Aug 2020 11:19:23 +0800 Subject: [PATCH 22/29] Fix output-folder for go SDK in timeseriesinsight (#10300) --- specification/timeseriesinsights/resource-manager/readme.go.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/timeseriesinsights/resource-manager/readme.go.md b/specification/timeseriesinsights/resource-manager/readme.go.md index cf66c104efd4..d10635c0c85f 100644 --- a/specification/timeseriesinsights/resource-manager/readme.go.md +++ b/specification/timeseriesinsights/resource-manager/readme.go.md @@ -52,5 +52,5 @@ These settings apply only when `--tag=package-2020-05-15 --go` is specified on t Please also specify `--go-sdk-folder=`. ``` yaml $(tag)=='package-2020-05-15' && $(go) -output-folder: $(go-sdk-folder)/services/stable/$(namespace)/mgmt/2020-05-15$(namespace) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-05-15/$(namespace) ``` \ No newline at end of file From 1103769978334ac9615bfcf3cc65ced1a07fe888 Mon Sep 17 00:00:00 2001 From: "[MSFT] Bowen Wan" Date: Mon, 3 Aug 2020 13:26:49 +0800 Subject: [PATCH 23/29] Add network profile in Spring payload. (#10313) * Add network profile in Spring payload. * Fix prettier check. * Fix prettier. --- .../2019-05-01-preview/appplatform.json | 33 ++++++++ .../examples/Services_CreateOrUpdate.json | 12 +-- ...Services_CreateOrUpdate_VNetInjection.json | 81 +++++++++++++++++++ .../examples/Services_Get.json | 4 +- .../examples/Services_List.json | 4 +- .../examples/Services_ListBySubscription.json | 4 +- .../examples/Services_Update.json | 12 +-- 7 files changed, 132 insertions(+), 18 deletions(-) create mode 100644 specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_CreateOrUpdate_VNetInjection.json 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 e9020e72f54f..72a4748132a2 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 @@ -113,6 +113,9 @@ "x-ms-examples": { "Services_CreateOrUpdate": { "$ref": "./examples/Services_CreateOrUpdate.json" + }, + "Services_CreateOrUpdate_VNetInjection": { + "$ref": "./examples/Services_CreateOrUpdate_VNetInjection.json" } } }, @@ -2296,6 +2299,10 @@ "$ref": "#/definitions/TraceProperties", "description": "Trace properties of the Service" }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Network profile of the Service" + }, "version": { "format": "int32", "description": "Version of the Service", @@ -2416,6 +2423,32 @@ } } }, + "NetworkProfile": { + "description": "Service network profile payload", + "type": "object", + "properties": { + "serviceRuntimeSubnetId": { + "description": "Fully qualified resource Id of the subnet to host Azure Spring Cloud Service Runtime", + "type": "string" + }, + "appSubnetId": { + "description": "Fully qualified resource Id of the subnet to host Azure Spring Cloud Apps", + "type": "string" + }, + "serviceCidr": { + "description": "Azure Spring Cloud service reserved CIDR", + "type": "string" + }, + "serviceRuntimeNetworkResourceGroup": { + "description": "Name of the resource group containing network resources of Azure Spring Cloud Service Runtime", + "type": "string" + }, + "appNetworkResourceGroup": { + "description": "Name of the resource group containing network resources of Azure Spring Cloud Apps", + "type": "string" + } + } + }, "Error": { "description": "The error code compose of code and message.", "type": "object", 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 0b9eb4797dc1..025ca3152466 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 @@ -19,8 +19,8 @@ } }, "sku": { - "name": "P0", - "tier": "Premium" + "name": "S0", + "tier": "Standard" }, "location": "eastus", "tags": { @@ -58,8 +58,8 @@ }, "type": "Microsoft.AppPlatform/Spring", "sku": { - "name": "P0", - "tier": "Premium" + "name": "S0", + "tier": "Standard" }, "location": "eastus", "tags": { @@ -94,8 +94,8 @@ }, "type": "Microsoft.AppPlatform/Spring", "sku": { - "name": "P0", - "tier": "Premium" + "name": "S0", + "tier": "Standard" }, "location": "eastus", "tags": { 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 new file mode 100644 index 000000000000..282f4e0d1dc3 --- /dev/null +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Services_CreateOrUpdate_VNetInjection.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "resource": { + "properties": { + "networkProfile": { + "serviceRuntimeSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/serviceRuntime", + "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" + } + }, + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2019-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "serviceName": "myservice" + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Creating", + "networkProfile": { + "serviceRuntimeSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/serviceRuntime", + "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" + }, + "serviceId": "12345678abcd1234abcd12345678abcd" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + }, + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "networkProfile": { + "serviceRuntimeSubnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/serviceRuntime", + "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" + }, + "serviceId": "12345678abcd1234abcd12345678abcd" + }, + "type": "Microsoft.AppPlatform/Spring", + "sku": { + "name": "S0", + "tier": "Standard" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice", + "name": "myservice" + } + } + } +} 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 0fd464fbf73c..533a76844cc0 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 @@ -31,8 +31,8 @@ }, "type": "Microsoft.AppPlatform/Spring", "sku": { - "name": "P0", - "tier": "Premium" + "name": "S0", + "tier": "Standard" }, "location": "eastus", "tags": { 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 60bff7e0b137..15723d2c8147 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 @@ -32,8 +32,8 @@ }, "type": "Microsoft.AppPlatform/Spring", "sku": { - "name": "P0", - "tier": "Premium" + "name": "S0", + "tier": "Standard" }, "location": "eastus", "tags": { 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 1e7ffa74d93f..3d07b6937972 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 @@ -31,8 +31,8 @@ }, "type": "Microsoft.AppPlatform/Spring", "sku": { - "name": "P0", - "tier": "Premium" + "name": "S0", + "tier": "Standard" }, "location": "eastus", "tags": { 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 6ff77da01f9b..066d495c9f61 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 @@ -19,8 +19,8 @@ } }, "sku": { - "name": "P0", - "tier": "Premium" + "name": "S0", + "tier": "Standard" }, "location": "eastus", "tags": { @@ -58,8 +58,8 @@ }, "type": "Microsoft.AppPlatform/Spring", "sku": { - "name": "P0", - "tier": "Premium" + "name": "S0", + "tier": "Standard" }, "location": "eastus", "tags": { @@ -94,8 +94,8 @@ }, "type": "Microsoft.AppPlatform/Spring", "sku": { - "name": "P0", - "tier": "Premium" + "name": "S0", + "tier": "Standard" }, "location": "eastus", "tags": { From cb01675ca2d33a323a08a0b66f5b2811c2208247 Mon Sep 17 00:00:00 2001 From: Somesh Chatterjee Date: Sun, 2 Aug 2020 23:01:50 -0700 Subject: [PATCH 24/29] Notebooks swagger spec (#9841) * Notebooks swagger spec * New line at the end of file * Remove new line at the end * PR feedback * Fix CI errors' * Add custom words * Add readme * Renamed examples folder * Add operations API * Fix prettier * Fix parameter name * Linter fixes * Fix examples * Fix CI errors * Fix CI error * CI fixes * CI fixes * CI fixes' * CI fixes Co-authored-by: Somesh Chatterjee --- custom-words.txt | 3 + .../examples/NBResourceCreate.json | 36 + .../examples/NBResourceDelete.json | 26 + .../examples/NBResourceGet.json | 25 + .../examples/NBResourceList.json | 38 + .../examples/NBResourceListCredentials.json | 17 + .../examples/NBResourcePEDelete.json | 25 + .../examples/NBResourcePEUpdate.json | 82 ++ .../preview/2019-10-11-preview/notebooks.json | 808 ++++++++++++++++++ .../preview/2019-10-11-preview/readme.cli.md | 9 + .../preview/2019-10-11-preview/readme.md | 66 ++ .../2019-10-11-preview/readme.python.md | 27 + 12 files changed, 1162 insertions(+) create mode 100644 specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceCreate.json create mode 100644 specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceDelete.json create mode 100644 specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceGet.json create mode 100644 specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceList.json create mode 100644 specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceListCredentials.json create mode 100644 specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourcePEDelete.json create mode 100644 specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourcePEUpdate.json create mode 100644 specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/notebooks.json create mode 100644 specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.cli.md create mode 100644 specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.md create mode 100644 specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.python.md diff --git a/custom-words.txt b/custom-words.txt index 7cfe2a125bc6..2301b3ecdcc3 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -149,6 +149,7 @@ autoscaling Avro avrodeflate AZFW +AZNB azns azpkg azureaccounts @@ -1024,6 +1025,7 @@ nopublicipaddresses northcentralus northeurope nostore +notebookapis notificationchannels notificationhubs notstarted @@ -1573,6 +1575,7 @@ testall testallroutes testnew testnewroute +testpl testresultfile textanalytics TFIDF diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceCreate.json b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceCreate.json new file mode 100644 index 000000000000..3d9864c0be9e --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceCreate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "resourceName": "testResource", + "resourceGroupName": "testRP", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "hostname": "Azure Notebooks" + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRP/providers/Microsoft.Notebooks/NotebookProxies/testResource", + "name": "testResource", + "type": "Microsoft.Notebooks/NotebookProxies", + "properties": { + "resourceId": "acc07b62291e4a4a800f71ff252e0654", + "hostname": "Azure Notebooks" + } + } + }, + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRP/providers/Microsoft.Notebooks/NotebookProxies/testResource", + "name": "testResource", + "type": "Microsoft.Notebooks/NotebookProxies", + "properties": { + "resourceId": "acc07b62291e4a4a800f71ff252e0654", + "hostname": "Azure Notebooks" + } + } + } + } +} diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceDelete.json b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceDelete.json new file mode 100644 index 000000000000..3c63585808a9 --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceDelete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testResource", + "resourceGroupName": "testRP", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "hostname": "Azure Notebooks" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRP/providers/Microsoft.Notebooks/NotebookProxies/testResource", + "name": "testResource", + "type": "Microsoft.Notebooks/NotebookProxies", + "properties": { + "resourceId": "acc07b62291e4a4a800f71ff252e0654", + "hostname": "Azure Notebooks" + } + } + }, + "204": {} + } +} diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceGet.json b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceGet.json new file mode 100644 index 000000000000..5d5fa97a066e --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceName": "testResource", + "resourceGroupName": "testRP", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "hostname": "Azure Notebooks" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRP/providers/Microsoft.Notebooks/NotebookProxies/testResource", + "name": "testResource", + "type": "Microsoft.Notebooks/NotebookProxies", + "properties": { + "resourceId": "acc07b62291e4a4a800f71ff252e0654", + "hostname": "Azure Notebooks" + } + } + } + } +} diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceList.json b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceList.json new file mode 100644 index 000000000000..32ccd88715a7 --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "resourceName": "testResource", + "resourceGroupName": "testRP", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters": { + "properties": { + "hostname": "Azure Notebooks" + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRP/providers/Microsoft.Notebooks/NotebookProxies/testResource", + "name": "testResource", + "type": "Microsoft.Notebooks/NotebookProxies", + "properties": { + "resourceId": "acc07b62291e4a4a800f71ff252e0654", + "hostname": "Azure Notebooks" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRP/providers/Microsoft.Notebooks/NotebookProxies/testResource2", + "name": "testResource2", + "type": "Microsoft.Notebooks/NotebookProxies", + "properties": { + "resourceId": "bcc07b62291e4a4a800f71ff252e0654", + "hostname": "Azure Notebooks" + } + } + ] + } + } + } +} diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceListCredentials.json b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceListCredentials.json new file mode 100644 index 000000000000..bf9538056f11 --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourceListCredentials.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceName": "testResource", + "resourceGroupName": "testRP", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "resourceId": "acc07b62291e4a4a800f71ff252e0654", + "primaryAccessKey": "42c43f86f937487dbc84256fab515bf2d80754b249154ded8ede0f5ded3733be", + "secondaryAccessKey": "1cef8965a0224bd896d27f87a7cabf1687e99f6412cd4c2ca25e5908d2105f79", + "hostname": "Azure Notebooks" + } + } + } +} diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourcePEDelete.json b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourcePEDelete.json new file mode 100644 index 000000000000..eaaa8c198c6a --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourcePEDelete.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceName": "testPL1-1", + "resourceGroupName": "testRP", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "privateLinkId": "testPL1-proxy.dc9bcc9d-dbd2-48ba-bbbb-bcbdaed437ae", + "parameters": { + "properties": { + "hostname": "Azure Notebooks" + }, + "connectionDetails": [ + { + "id": "f6124779c97049738cc02655385b62ab_1111", + "privateIpAddress": "10.10.10.1", + "linkIdentifier": 1111, + "groupId": "f6124779c97049738cc02655385b62ab", + "memberName": "f6124779c97049738cc02655385b62ab_member" + } + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourcePEUpdate.json b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourcePEUpdate.json new file mode 100644 index 000000000000..e5382984121a --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/examples/NBResourcePEUpdate.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "resourceName": "testPL1-1", + "resourceGroupName": "testRP", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "privateLinkId": "testPL1-proxy.dc9bcc9d-dbd2-48ba-bbbb-bcbdaed437ae", + "parameters": { + "properties": { + "hostname": "Azure Notebooks", + "connectionDetails": [ + { + "id": "f6124779c97049738cc02655385b62ab_1111", + "privateIpAddress": "10.10.10.1", + "linkIdentifier": 1111, + "groupId": "f6124779c97049738cc02655385b62ab", + "memberName": "f6124779c97049738cc02655385b62ab_member" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRp/providers/Microsoft.Network/privateEndpoints/testPL1-1", + "privateLinkServiceProxies": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000//resourceGroups/testRp/providers/Microsoft.Network/privateEndpoints/testPL1-1/privateLinkServiceProxies/testPL1-proxy.dc9bcc9d-dbd2-48ba-bbbb-bcbdaed437ae", + "groupConnectivityInformation": [ + { + "groupId": "f6124779c97049738cc02655385b62ab", + "memberName": "f6124779c97049738cc02655385b62ab_member", + "customerVisibleFqdns": [ + "testpl1.notebooks-test.azure.net" + ], + "internalFqdn": "privatelink.notebookapis-dev2.azure.com" + } + ] + } + ], + "connectionDetails": [ + { + "id": "f6124779c97049738cc02655385b62ab_1111", + "privateIpAddress": "10.10.10.1", + "linkIdentifier": 1111, + "groupId": "f6124779c97049738cc02655385b62ab", + "memberName": "f6124779c97049738cc02655385b62ab_member" + } + ] + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRp/providers/Microsoft.Network/privateEndpoints/testPL1-1", + "privateLinkServiceProxies": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000//resourceGroups/testRp/providers/Microsoft.Network/privateEndpoints/testPL1-1/privateLinkServiceProxies/testPL1-proxy.dc9bcc9d-dbd2-48ba-bbbb-bcbdaed437ae", + "groupConnectivityInformation": [ + { + "groupId": "f6124779c97049738cc02655385b62ab", + "memberName": "f6124779c97049738cc02655385b62ab_member", + "customerVisibleFqdns": [ + "testpl1.notebooks-test.azure.net" + ], + "internalFqdn": "privatelink.notebookapis-dev2.azure.com" + } + ] + } + ], + "connectionDetails": [ + { + "id": "f6124779c97049738cc02655385b62ab_1111", + "privateIpAddress": "10.10.10.1", + "linkIdentifier": 1111, + "groupId": "f6124779c97049738cc02655385b62ab", + "memberName": "f6124779c97049738cc02655385b62ab_member" + } + ] + } + } + } +} diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/notebooks.json b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/notebooks.json new file mode 100644 index 000000000000..6fa544b75490 --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/notebooks.json @@ -0,0 +1,808 @@ +{ + "swagger": "2.0", + "info": { + "description": "Azure Notebooks Resource Management Client", + "version": "2019-10-11-preview", + "title": "NotebookResourceManagementClient" + }, + "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": { + "/providers/Microsoft.Notebooks/operations": { + "get": { + "tags": [ + "Operation" + ], + "description": "Lists all of the available Azure Notebooks REST API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Notebooks/notebookProxies/{resourceName}": { + "get": { + "tags": [ + "NotebookProxy" + ], + "operationId": "NotebookProxies_Get", + "x-ms-examples": { + "Get Notebook Proxy": { + "$ref": "./examples/NBResourceGet.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "summary": "Get the properties of the specified NotebookProxy.", + "description": "Gets the properties of the specified NotebookProxy resource in the specified subscription and resource group. This operation returns properties of specified NotebookProxy resource including resourceId, credentials, and systemData.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NotebookProxy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "NotebookProxy" + ], + "operationId": "NotebookProxies_CreateOrUpdate", + "x-ms-examples": { + "Create Notebook Proxy": { + "$ref": "./examples/NBResourceCreate.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "summary": "Create or update NotebookProxy resource.", + "description": "Create or update NotebookProxy resource with specified configuration.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "description": "The properties of the NotebookProxy to be created or updated.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NotebookProxy" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NotebookProxy" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/NotebookProxy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "NotebookProxy" + ], + "operationId": "NotebookProxies_Delete", + "x-ms-examples": { + "Delete Notebook Proxy": { + "$ref": "./examples/NBResourceDelete.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "summary": "Delete the specified NotebookProxy.", + "description": "Delete the specified NotebookProxy in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NotebookProxy" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Notebooks/notebookProxies": { + "get": { + "tags": [ + "NotebookProxy" + ], + "operationId": "NotebookProxies_ListByResourceGroup", + "x-ms-examples": { + "List Notebook Proxy by Resource Group": { + "$ref": "./examples/NBResourceList.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "summary": "Get a list of NotebookProxy resources in the specified subscription and resource group.", + "description": "Get a list of NotebookProxy resources in the specified subscription and resource group. This operation returns properties of each NotebookProxy including resourceId, credentials, and systemData.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NotebookProxyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Notebooks/notebookProxies": { + "get": { + "tags": [ + "NotebookProxy" + ], + "operationId": "NotebookProxies_List", + "x-ms-examples": { + "List Notebook Proxy by Subscription": { + "$ref": "./examples/NBResourceList.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "summary": "Get a list of NotebookProxy resources in the specified subscription.", + "description": "Get a list of NotebookProxy resources in the specified subscription. This operation returns properties of each NotebookProxy including resourceId, credentials, and systemData.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NotebookProxyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Notebooks/notebookProxies/{resourceName}/listCredentials": { + "post": { + "tags": [ + "NotebookProxy" + ], + "operationId": "NotebookProxies_ListCredentials", + "x-ms-examples": { + "List Notebook Proxy Credentials": { + "$ref": "./examples/NBResourceListCredentials.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "summary": "Get the access keys of the specified NotebookProxy.", + "description": "Get the access keys of the specified NotebookProxy. in the specified subscription and resource group. This operation returns resourceId, primaryAccessKey and secondaryAccessKey.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NotebookProxyCredentials" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Notebooks/notebookProxies/{resourceName}/privateEndpointConnectionProxies/{privateLinkId}": { + "post": { + "tags": [ + "NotebookProxy" + ], + "operationId": "PostPrivateLinkIdNotebookResource", + "x-ms-examples": { + "Create Notebook Proxy Private Endpoint": { + "$ref": "./examples/NBResourcePEUpdate.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "privateLinkId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "resourceRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NotebookPEResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NotebookPEResponse" + } + }, + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NotebookPEResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Notebooks/notebookProxies/{resourceName}/removePrivateLinkId/{privateLinkId}": { + "post": { + "tags": [ + "NotebookProxy" + ], + "operationId": "RemovePrivateLinkIdNotebookResource", + "x-ms-examples": { + "Remove Notebook Proxy Private Endpoint": { + "$ref": "./examples/NBResourcePEDelete.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "privateLinkId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "resourceRequest", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NotebookPEResponse" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "NotebookProxy": { + "description": "A NotebookProxy resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NotebookResourceEntity", + "description": "The properties of NotebookProxy resource.", + "x-ms-client-flatten": true + } + } + }, + "NotebookResourceEntity": { + "description": "Properties of NotebookProxy resource", + "type": "object", + "properties": { + "resourceId": { + "description": "The unique identifier (a GUID) generated for every resource.", + "type": "string", + "readOnly": true + }, + "hostname": { + "description": "The friendly string identifier of the creator of the NotebookProxy resource.", + "type": "string" + } + } + }, + "NotebookPEResource": { + "description": "Notebooks Proxy resource with Private Link", + "type": "object", + "properties": { + "hostname": { + "description": "The friendly string identifier of the creator of the NotebookProxy resource.", + "type": "string" + }, + "connectionDetails": { + "description": "Private link connection details", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionDetail" + } + } + } + }, + "NotebookPEResponse": { + "description": "Private Endpoint details for a Notebook Proxy resource", + "type": "object", + "properties": { + "id": { + "description": "Private endpoint id", + "type": "string" + }, + "privateLinkServiceProxies": { + "description": "Private endpoint service proxies", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointServiceProxy" + } + }, + "connectionDetails": { + "description": "Private link connection details", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionDetail" + } + } + } + }, + "PrivateEndpointServiceProxy": { + "description": "Private Endpoint service proxy details", + "type": "object", + "properties": { + "id": { + "description": "Service proxy id", + "type": "string" + }, + "groupConnectivityInformation": { + "description": "Group connectivity information", + "type": "array", + "items": { + "$ref": "#/definitions/GroupConnectivityInformation" + } + } + } + }, + "GroupConnectivityInformation": { + "description": "Private link Group Connectivity Detail", + "type": "object", + "properties": { + "internalFqdn": { + "description": "Internal fully qualified domain name", + "type": "string" + }, + "customerVisibleFqdns": { + "description": "Customer visible fully qualified domain names", + "type": "array", + "items": { + "type": "string" + } + }, + "groupId": { + "description": "Private link group Id", + "type": "string" + }, + "memberName": { + "description": "Private link member name", + "type": "string" + } + } + }, + "ConnectionDetail": { + "description": "Private link Connection Detail", + "type": "object", + "properties": { + "id": { + "description": "Private link connection id", + "type": "string" + }, + "privateIpAddress": { + "description": "Private endpoint IP address", + "type": "string" + }, + "linkIdentifier": { + "description": "Link Id for the private link", + "type": "integer", + "format": "int32" + }, + "groupId": { + "description": "Private link group Id", + "type": "string" + }, + "memberName": { + "description": "Private link member name", + "type": "string" + } + } + }, + "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.Storage/storageAccounts or Microsoft.Notebooks/notebookProxies." + } + }, + "x-ms-azure-resource": true + }, + "CloudError": { + "type": "object", + "description": "Wrapper for error response to follow ARM guidelines.", + "properties": { + "error": { + "description": "The error response.", + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response information.", + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "array", + "description": "An array of error detail objects.", + "items": { + "$ref": "#/definitions/ErrorDetail" + } + } + }, + "required": [ + "code", + "message" + ] + }, + "ErrorDetail": { + "type": "object", + "description": "Error detail information.", + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + } + }, + "required": [ + "code", + "message" + ] + }, + "Operation": { + "description": "Azure Notebooks Proxy REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display name of operation", + "properties": { + "provider": { + "description": "The resource provider name: Microsoft.Notebooks", + "type": "string" + }, + "resource": { + "description": "The resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The operation that users can perform.", + "type": "string" + }, + "description": { + "description": "The description for the operation.", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "An array of operations supported by the resource provider.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Notebook Proxy operations supported by the Azure Notebooks resource provider." + } + } + }, + "NotebookProxyListResult": { + "description": "The response containing list of NotebookProxy resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NotebookProxy" + }, + "description": "The list of NotebookProxy resources." + }, + "nextLink": { + "description": "The URI that can be used to request the next list of NotebookProxy resources.", + "type": "string" + } + } + }, + "NotebookProxyCredentials": { + "description": "Credentials and other properties of NotebookProxy resource", + "type": "object", + "readOnly": true, + "properties": { + "resourceId": { + "description": "Notebook Proxy resource id", + "type": "string" + }, + "primaryAccessKey": { + "description": "The primary key of the NotebookProxy resource.", + "type": "string" + }, + "secondaryAccessKey": { + "description": "The secondary key of the NotebookProxy resource.", + "type": "string" + }, + "hostname": { + "description": "Hostname for the Notebook Proxy resource", + "type": "string" + } + } + } + }, + "parameters": { + "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" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource.", + "minLength": 1, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.cli.md b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.cli.md new file mode 100644 index 000000000000..7712f4b56527 --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.cli.md @@ -0,0 +1,9 @@ +## CLI + +These settings apply only when `--cli` is specified on the command line. + +``` yaml $(cli) +#cli: +# test-scenario: +# - name: Example_CreateOrUpdate +``` diff --git a/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.md b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.md new file mode 100644 index 000000000000..b8e37386caa2 --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.md @@ -0,0 +1,66 @@ +# Notebooks + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Azure Notebooks Resource Management Client. + +--- +## Getting Started +To build the SDK for Azure Resource Management, 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 Azure Notebooks Resource Management Client. + +``` yaml +openapi-type: arm +tag: package-2019-10-11-preview +``` +### Tag: package-2019-10-11-preview + +These settings apply only when `--tag=package-2019-10-11-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2019-10-11-preview' +input-file: +- notebooks.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. + +## 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: + - notebooks.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/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.python.md b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.python.md new file mode 100644 index 000000000000..d4181ff7ef65 --- /dev/null +++ b/specification/notebooks/resource-manager/Microsoft.Notebooks/preview/2019-10-11-preview/readme.python.md @@ -0,0 +1,27 @@ +## 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: Microsoft.Notebooks + package-name: notebooks + package-version: 2019-10-11-preview + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt/notebooks +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt/notebooks +``` From b7002b3d7ca8c948723606d92ee1adbf87ca9aff Mon Sep 17 00:00:00 2001 From: Elad Perets <7473455+eladperets@users.noreply.github.com> Date: Sun, 2 Aug 2020 23:19:23 -0700 Subject: [PATCH 25/29] Fix Microsoft.Resources naming issue (#10318) * Fix Microsoft.Resources naming issue The 'operation' enum conflicts with the 'operation' object definition during .NET sdk generation. Renaming the enum to avoid that. * Use camel case enum name --- .../Microsoft.Resources/stable/2019-10-01/resources.json | 2 +- .../Microsoft.Resources/stable/2020-06-01/resources.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json index 64763dca9c3a..9f40dec3bcba 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json @@ -5930,7 +5930,7 @@ "Delete" ], "x-ms-enum": { - "name": "operation", + "name": "tagsPatchOperation", "modelAsString": true, "values": [ { diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json index 96b7e2efcdaa..cb91fbec0f89 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json @@ -6083,7 +6083,7 @@ "Delete" ], "x-ms-enum": { - "name": "operation", + "name": "tagsPatchOperation", "modelAsString": true, "values": [ { From 4ead64dd00f8573b46e132b9e1058322cb1645a7 Mon Sep 17 00:00:00 2001 From: Matt <57731498+mattmsft@users.noreply.github.com> Date: Mon, 3 Aug 2020 07:45:08 -0700 Subject: [PATCH 26/29] Add native blob soft delete (#10308) * swagger changes for native soft delete * revert track1 changes --- .../preview/2019-05-06-preview/searchservice.json | 9 +++++++++ .../preview/2020-06-30-Preview/searchservice.json | 9 +++++++++ .../Azure.Search/preview/2020-06-30/searchservice.json | 9 +++++++++ .../Azure.Search/stable/2019-05-06/searchservice.json | 9 +++++++++ 4 files changed, 36 insertions(+) diff --git a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json index c2a69aac29b9..ddead0180328 100644 --- a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json @@ -5628,6 +5628,15 @@ } } }, + "NativeBlobSoftDeleteDeletionDetectionPolicy": { + "description": "Defines a data deletion detection policy that captures deletions using the soft-deletion capability of Azure Blob Storage", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataDeletionDetectionPolicy" + } + ] + }, "SearchIndexerDataSourceType": { "type": "string", "enum": [ 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..4bf96e5ca874 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 @@ -5630,6 +5630,15 @@ } } }, + "NativeBlobSoftDeleteDeletionDetectionPolicy": { + "description": "Defines a data deletion detection policy that captures deletions using the soft-deletion capability of Azure Blob Storage", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataDeletionDetectionPolicy" + } + ] + }, "SearchIndexerDataSourceType": { "type": "string", "enum": [ 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..a3229ec0e5dd 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 @@ -5630,6 +5630,15 @@ } } }, + "NativeBlobSoftDeleteDeletionDetectionPolicy": { + "description": "Defines a data deletion detection policy that captures deletions using the soft-deletion capability of Azure Blob Storage", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataDeletionDetectionPolicy" + } + ] + }, "SearchIndexerDataSourceType": { "type": "string", "enum": [ diff --git a/specification/search/data-plane/Azure.Search/stable/2019-05-06/searchservice.json b/specification/search/data-plane/Azure.Search/stable/2019-05-06/searchservice.json index a160c1a6e433..8ec85eff6905 100644 --- a/specification/search/data-plane/Azure.Search/stable/2019-05-06/searchservice.json +++ b/specification/search/data-plane/Azure.Search/stable/2019-05-06/searchservice.json @@ -3774,6 +3774,15 @@ } } }, + "NativeBlobSoftDeleteDeletionDetectionPolicy": { + "description": "Defines a data deletion detection policy that captures deletions using the soft-deletion capability of Azure Blob Storage", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataDeletionDetectionPolicy" + } + ] + }, "DataSourceType": { "type": "string", "enum": [ From 4bb6de0fb61d522c75a807dcaa85e8bf7ee0f6b0 Mon Sep 17 00:00:00 2001 From: wonner Date: Mon, 3 Aug 2020 23:36:42 +0800 Subject: [PATCH 27/29] [Synapse] Support long running operation and add subclass of Activity in artifact (#10270) * change response status code * add activities * fix ModelValidation and PrettierCheck * long running operation * fix description * fix tab Co-authored-by: Wan Yang --- .../preview/2019-06-01-preview/artifacts.json | 108 +++++++++++++++++ .../entityTypes/Pipeline.json | 109 ++++++++++++++++++ .../examples/LinkedServices_Create.json | 6 +- .../examples/LinkedServices_Delete.json | 1 + .../examples/LinkedServices_Update.json | 6 +- .../examples/Notebooks_Create.json | 6 +- .../examples/Notebooks_Delete.json | 1 + .../examples/Notebooks_Update.json | 6 +- .../examples/Pipelines_Create.json | 6 +- .../examples/Pipelines_CreateRun.json | 6 +- .../examples/Pipelines_Delete.json | 1 + .../examples/Pipelines_Update.json | 6 +- .../examples/Triggers_Create.json | 6 +- .../examples/Triggers_Delete.json | 1 + .../examples/Triggers_Update.json | 6 +- 15 files changed, 257 insertions(+), 18 deletions(-) diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json index c7b8fb876b6d..4a768103cef3 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json @@ -77,6 +77,7 @@ } }, "description": "Creates or updates a linked service.", + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/linkedServiceName" @@ -108,6 +109,9 @@ "$ref": "#/definitions/LinkedServiceResource" } }, + "202": { + "description": "Accepted." + }, "default": { "description": "An error response received from the Azure Synapse service.", "schema": { @@ -171,6 +175,7 @@ } }, "description": "Deletes a linked service.", + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/linkedServiceName" @@ -183,6 +188,9 @@ "200": { "description": "OK." }, + "202": { + "description": "Accepted." + }, "204": { "description": "No Content." }, @@ -415,6 +423,7 @@ } }, "description": "Creates or updates a pipeline.", + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/pipelineName" @@ -446,6 +455,9 @@ "$ref": "#/definitions/PipelineResource" } }, + "202": { + "description": "Accepted." + }, "default": { "description": "An error response received from the Azure Synapse service.", "schema": { @@ -509,6 +521,7 @@ } }, "description": "Deletes a pipeline.", + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/pipelineName" @@ -521,6 +534,9 @@ "200": { "description": "OK." }, + "202": { + "description": "Accepted." + }, "204": { "description": "No Content." }, @@ -545,6 +561,7 @@ } }, "description": "Creates a run of a pipeline.", + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/pipelineName" @@ -593,6 +610,9 @@ "$ref": "#/definitions/CreateRunResponse" } }, + "202": { + "description": "Accepted." + }, "default": { "description": "An error response received from the Azure Synapse service.", "schema": { @@ -819,6 +839,7 @@ } }, "description": "Creates or updates a trigger.", + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/triggerName" @@ -850,6 +871,9 @@ "$ref": "#/definitions/TriggerResource" } }, + "202": { + "description": "Accepted." + }, "default": { "description": "An error response received from the Azure Synapse service.", "schema": { @@ -913,6 +937,7 @@ } }, "description": "Deletes a trigger.", + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/triggerName" @@ -925,6 +950,9 @@ "200": { "description": "OK." }, + "202": { + "description": "Accepted." + }, "204": { "description": "No Content." }, @@ -2145,6 +2173,7 @@ } }, "description": "Creates or updates a Note Book.", + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/NotebookName" @@ -2176,6 +2205,9 @@ "$ref": "#/definitions/NotebookResource" } }, + "202": { + "description": "Accepted." + }, "default": { "description": "An error response received from the Azure Synapse service.", "schema": { @@ -2239,6 +2271,7 @@ } }, "description": "Deletes a Note book.", + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/NotebookName" @@ -2251,6 +2284,9 @@ "200": { "description": "OK." }, + "202": { + "description": "Accepted." + }, "204": { "description": "No Content." }, @@ -4166,6 +4202,78 @@ "readOnly": true } } + }, + "SynapseNotebookReference": { + "description": "Synapse notebook reference type.", + "properties": { + "type": { + "type": "string", + "description": "Synapse notebook reference type.", + "enum": [ + "NotebookReference" + ], + "x-ms-enum": { + "name": "NotebookReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference notebook name." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "SynapseSparkJobReference": { + "description": "Synapse spark job reference type.", + "properties": { + "type": { + "type": "string", + "description": "Synapse spark job reference type.", + "enum": [ + "SparkJobDefinitionReference" + ], + "x-ms-enum": { + "name": "SparkJobReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference spark job name." + } + }, + "required": [ + "type", + "referenceName" + ] + }, + "SqlPoolReference": { + "description": "SQL pool reference type.", + "properties": { + "type": { + "type": "string", + "description": "SQL pool reference type.", + "enum": [ + "SqlPoolReference" + ], + "x-ms-enum": { + "name": "SqlPoolReferenceType", + "modelAsString": true + } + }, + "referenceName": { + "type": "string", + "description": "Reference SQL pool name." + } + }, + "required": [ + "type", + "referenceName" + ] } }, "parameters": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json index 2f1930156943..85156f10da86 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json @@ -5831,6 +5831,115 @@ "required": [ "dataFlow" ] + }, + "SynapseNotebookActivity": { + "description": "Execute Synapse notebook activity.", + "x-ms-discriminator-value": "SynapseNotebook", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute Synapse notebook activity properties.", + "$ref": "#/definitions/SynapseNotebookActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SynapseNotebookActivityTypeProperties": { + "description": "Execute Synapse notebook activity properties.", + "properties": { + "notebook": { + "description": "Synapse notebook reference.", + "$ref": "../artifacts.json#/definitions/SynapseNotebookReference" + }, + "parameters": { + "description": "Notebook parameters.", + "$ref": "../artifacts.json#/definitions/ParameterValueSpecification" + } + }, + "required": [ + "notebook" + ] + }, + "SynapseSparkJobDefinitionActivity": { + "description": "Execute spark job activity.", + "x-ms-discriminator-value": "SparkJob", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } + ], + "properties": { + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute spark job activity properties.", + "$ref": "#/definitions/SynapseSparkJobActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "SynapseSparkJobActivityTypeProperties": { + "description": "Execute spark job activity properties.", + "properties": { + "sparkJob": { + "description": "Synapse spark job reference.", + "$ref": "../artifacts.json#/definitions/SynapseSparkJobReference" + } + }, + "required": [ + "sparkJob" + ] + }, + "SqlPoolStoredProcedureActivity": { + "description": "Execute SQL pool stored procedure activity.", + "x-ms-discriminator-value": "SqlPoolStoredProcedure", + "allOf": [ + { + "$ref": "#/definitions/Activity" + } + ], + "properties": { + "sqlPool": { + "description": "SQL pool stored procedure reference.", + "$ref": "../artifacts.json#/definitions/SqlPoolReference" + }, + "typeProperties": { + "x-ms-client-flatten": true, + "description": "Execute SQL pool stored procedure activity properties.", + "$ref": "#/definitions/SqlPoolStoredProcedureActivityTypeProperties" + } + }, + "required": [ + "sqlPool", + "typeProperties" + ] + }, + "SqlPoolStoredProcedureActivityTypeProperties": { + "description": "SQL stored procedure activity properties.", + "properties": { + "storedProcedureName": { + "type": "object", + "description": "Stored procedure name. Type: string (or Expression with resultType string)." + }, + "storedProcedureParameters": { + "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StoredProcedureParameter" + } + } + }, + "required": [ + "storedProcedureName" + ] } } } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Create.json index 83813ca2dbd3..98aa40e23cce 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Create.json @@ -17,14 +17,16 @@ "api-version": "2019-06-01-preview" }, "responses": { - "200": { + "202": { "headers": { "Date": "Sat, 16 Jun 2018 00:37:34 GMT", "X-Content-Type-Options": "nosniff", "x-ms-ratelimit-remaining-subscription-writes": "1196", "x-ms-request-id": "b3b336b3-b203-4654-9cb6-a3a8d3a4b5de", "x-ms-correlation-request-id": "b3b336b3-b203-4654-9cb6-a3a8d3a4b5de" - }, + } + }, + "200": { "body": { "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/linkedservices/exampleLinkedService", "name": "exampleLinkedService", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Delete.json index d18fa82e8963..056099383983 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Delete.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Delete.json @@ -6,6 +6,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Update.json index 217788a059e1..4c187f4df71c 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Update.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Update.json @@ -18,14 +18,16 @@ "api-version": "2019-06-01-preview" }, "responses": { - "200": { + "202": { "headers": { "Date": "Sat, 16 Jun 2018 00:37:36 GMT", "X-Content-Type-Options": "nosniff", "x-ms-ratelimit-remaining-subscription-writes": "1195", "x-ms-request-id": "53ad9761-ecdf-43ed-916f-878a5fb92cb0", "x-ms-correlation-request-id": "53ad9761-ecdf-43ed-916f-878a5fb92cb0" - }, + } + }, + "200": { "body": { "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/linkedservices/exampleLinkedService", "name": "exampleLinkedService", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Create.json index 6dfcafc232ee..fbfd87d5af67 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Create.json @@ -56,14 +56,16 @@ "api-version": "2019-06-01-preview" }, "responses": { - "200": { + "202": { "headers": { "Date": "Sat, 16 Jun 2018 00:37:41 GMT", "X-Content-Type-Options": "nosniff", "x-ms-ratelimit-remaining-subscription-writes": "1192", "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" - }, + } + }, + "200": { "body": { "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/Notebooks/exampleNotebook", "name": "exampleNotebook", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Delete.json index 58395fa417a1..18eb27bcf289 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Delete.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Delete.json @@ -6,6 +6,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Update.json index c84e1a5f1741..2bb3761e3bc4 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Update.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Update.json @@ -56,14 +56,16 @@ "api-version": "2019-06-01-preview" }, "responses": { - "200": { + "202": { "headers": { "Date": "Sat, 16 Jun 2018 00:37:41 GMT", "X-Content-Type-Options": "nosniff", "x-ms-ratelimit-remaining-subscription-writes": "1192", "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" - }, + } + }, + "200": { "body": { "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook", "name": "exampleNotebook", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Create.json index 399eb460bf34..209be01f3755 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Create.json @@ -80,14 +80,16 @@ "api-version": "2019-06-01-preview" }, "responses": { - "200": { + "202": { "headers": { "Date": "Sat, 16 Jun 2018 00:37:41 GMT", "X-Content-Type-Options": "nosniff", "x-ms-ratelimit-remaining-subscription-writes": "1192", "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" - }, + } + }, + "200": { "body": { "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/pipelines/examplePipeline", "name": "examplePipeline", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_CreateRun.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_CreateRun.json index 7c4ec522a5a3..85c50f17c706 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_CreateRun.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_CreateRun.json @@ -11,14 +11,16 @@ "api-version": "2019-06-01-preview" }, "responses": { - "200": { + "202": { "headers": { "Date": "Sat, 16 Jun 2018 00:37:48 GMT", "X-Content-Type-Options": "nosniff", "x-ms-ratelimit-remaining-subscription-writes": "1190", "x-ms-request-id": "5c2b442b-d360-43ec-9268-f923f88f31fd", "x-ms-correlation-request-id": "5c2b442b-d360-43ec-9268-f923f88f31fd" - }, + } + }, + "200": { "body": { "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b" } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Delete.json index 4a7573f09103..f11dbd33965e 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Delete.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Delete.json @@ -6,6 +6,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Update.json index b5718b15aa75..df05abf27735 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Update.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Update.json @@ -67,14 +67,16 @@ "api-version": "2019-06-01-preview" }, "responses": { - "200": { + "202": { "headers": { "Date": "Sat, 16 Jun 2018 00:37:43 GMT", "X-Content-Type-Options": "nosniff", "x-ms-ratelimit-remaining-subscription-writes": "1191", "x-ms-request-id": "91a763b0-d944-493f-83fc-e989c8b6e122", "x-ms-correlation-request-id": "91a763b0-d944-493f-83fc-e989c8b6e122" - }, + } + }, + "200": { "body": { "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/pipelines/examplePipeline", "name": "examplePipeline", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Create.json index c93a8820594c..939534b0e3b2 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Create.json @@ -33,14 +33,16 @@ "api-version": "2019-06-01-preview" }, "responses": { - "200": { + "202": { "headers": { "Date": "Sat, 16 Jun 2018 00:40:14 GMT", "X-Content-Type-Options": "nosniff", "x-ms-ratelimit-remaining-subscription-writes": "1186", "x-ms-request-id": "373f1a49-685d-4c07-8857-0fcf1bcaffcb", "x-ms-correlation-request-id": "373f1a49-685d-4c07-8857-0fcf1bcaffcb" - }, + } + }, + "200": { "body": { "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger", "name": "exampleTrigger", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Delete.json index b3a88c1cd75e..4d223d73cce6 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Delete.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Delete.json @@ -6,6 +6,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Update.json index a86583945183..d2b7d38757f8 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Update.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Update.json @@ -34,14 +34,16 @@ "api-version": "2019-06-01-preview" }, "responses": { - "200": { + "202": { "headers": { "Date": "Sat, 16 Jun 2018 00:40:15 GMT", "X-Content-Type-Options": "nosniff", "x-ms-ratelimit-remaining-subscription-writes": "1185", "x-ms-request-id": "d5ccf096-0618-4b26-9829-db77e4c391c7", "x-ms-correlation-request-id": "d5ccf096-0618-4b26-9829-db77e4c391c7" - }, + } + }, + "200": { "body": { "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger", "name": "exampleTrigger", From 30fcbd8d18834a432c031d252d735eb5bbcc02bf Mon Sep 17 00:00:00 2001 From: gubalasu <59630928+gubalasu@users.noreply.github.com> Date: Mon, 3 Aug 2020 19:50:23 -0700 Subject: [PATCH 28/29] Add Url Signing action definition (#10326) --- .../Microsoft.Cdn/stable/2020-03-31/cdn.json | 18 ++++++++++++++++++ .../Microsoft.Cdn/stable/2020-04-15/cdn.json | 18 ++++++++++++++++++ 2 files changed, 36 insertions(+) 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 447afda283be..40bda7fa0c28 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 @@ -3864,6 +3864,24 @@ } } }, + "UrlSigningAction": { + "description": "Defines the url signing action for the delivery rule.", + "x-ms-discriminator-value": "UrlSigning", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/UrlSigningActionParameters" + } + } + }, "UrlSigningActionParameters": { "description": "Defines the parameters for the Url Signing action.", "required": [ 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 30e6c89613de..2fcd9a9690c9 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 @@ -3864,6 +3864,24 @@ } } }, + "UrlSigningAction": { + "description": "Defines the url signing action for the delivery rule.", + "x-ms-discriminator-value": "UrlSigning", + "allOf": [ + { + "$ref": "#/definitions/DeliveryRuleAction" + } + ], + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "description": "Defines the parameters for the action.", + "$ref": "#/definitions/UrlSigningActionParameters" + } + } + }, "UrlSigningActionParameters": { "description": "Defines the parameters for the Url Signing action.", "required": [ From e345bb9e034dbb68b57efff801b3268fc86f3319 Mon Sep 17 00:00:00 2001 From: Amit Bergman <38046493+Amitbergman@users.noreply.github.com> Date: Tue, 4 Aug 2020 10:00:15 +0300 Subject: [PATCH 29/29] Add preAttack tactic to swagger (#10332) --- .../preview/2019-01-01-preview/SecurityInsights.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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 b7c7afad2beb..23bcd534e567 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 @@ -3968,7 +3968,8 @@ "Collection", "Exfiltration", "CommandAndControl", - "Impact" + "Impact", + "PreAttack" ], "type": "string", "x-ms-enum": {